You can extend the capabilities of StreamBase applications by creating custom programs that use the StreamBase Client libraries for Java, C++, .NET, and Python. The class references for the StreamBase API are provided in the following locations and formats:
-
Java API Documentation is the Javadoc reference for the StreamBase Java Client library.
-
C++ API Documentation is the Doxygen reference for the StreamBase C++ Client library.
-
Python API Documentation is the Pydoc reference for the StreamBase Python Client library.
-
The .NET Client library documentation is provided in HTML Help format only on Windows installations of StreamBase. Look in the Start menu for a link to StreamBase
n.m.NET API.
Note
Classes and elements of classes listed in the Javadoc, Doxygen, Pydoc, 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.
The StreamBase Client library for different languages supports the types of StreamBase extensions described in the following table:
Reference Pages
| StreamBase Environment Variables |
| StreamBase Java System Properties |
| StreamBase Expression Language Functions |
| StreamBase Extension | Java | C++ | .NET | Python |
|---|---|---|---|---|
| Client applications | yes | yes | yes | yes |
| Custom functions | yes | yes | — | — |
| Custom operators | yes | — | — | — |
| Embedded adapters | yes | — | — | — |
| Monitor applications | yes | — | yes | — |
The following topics provide overviews of developing each type of custom extension:
- 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++, .NET, or Python Client libraries.
- 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++ Client libraries.
- Developing Java Operators
-
Java operators add custom functionality within the flow of your StreamBase application. They are created with the Java Client library.
- 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 Client library.
- Developing StreamBase Monitor Applications
-
Use the StreamBase Monitor API to create client programs that obtain and process statistical data about applications on the currently running StreamBase Server. The Monitor API is a subset of the StreamBase Java and .NET Client libraries.
- General Topics for all Client Library Users
- API Change History