StreamBase API Guide

Introduction

You can extend the capabilities of StreamBase applications by creating custom programs that use the StreamBase API for Java, C++, and .NET.

The following topics describe how to develop each type of custom program:

Developing Client Applications

Client applications are independent applications that either enqueue data into a running StreamBase application, or dequeue data from a StreamBase application for further processing. You can create clients using the StreamBase Java, C++, or .NET APIs.

Developing Embedded Adapters

Embedded adapters can enqueue or dequeue data like clients, but adapters are not independent. They are included as components within StreamBase applications, and start and stop with the StreamBase application. Embedded adapters are created with the Java API.

Developing Java Operators

Java operators add custom functionality within the flow of your StreamBase application. They are created with the Java API.

Developing Custom Functions

Custom functions extend the StreamBase expression language, and can be called in expressions from within StreamBase components. They can be written with either the Java or C++ APIs.

Developing StreamBase Monitor Applications

Use the StreamBase Monitor API to create client programs that obtain and process statistical data about currently running StreamBase applications and the StreamBase Server. The Monitor API is a subset of the StreamBase Java API.

The following topics apply to all users of the StreamBase API:

Language-Specific Cross-Reference

Users of the StreamBase Java API can develop the following types of customizations:

  • StreamBase client applications

  • StreamBase embedded adapters

  • Custom operators for StreamBase applications

  • Custom functions to extend the StreamBase expression language

  • StreamBase monitor applications

Users of the StreamBase C++ API can develop the following customizations:

  • StreamBase client applications

  • Custom functions to extend the StreamBase expression language

Users of the StreamBase .NET API can develop:

  • StreamBase client applications

  • StreamBase monitor applications

API Documentation

Note

Classes and elements of classes listed in the Javadoc, Doxygen, and .NET documentation comprise the complete set of publicly-accessible APIs. Elements in classes that do not appear in the documentation are for internal use only, and are not supported for use in customer code.

  • Java API Documentation is the Javadoc reference for the StreamBase Java API.

  • C++ API Documentation is the Doxygen reference for the StreamBase C++ API.

  • The .NET API documentation is provided in HTML Help format only on Windows installations of StreamBase. Select Start(All) ProgramsStreamBase n.mStreamBase API DocumentationStreamBase .NET API .