RTPP Adapter

The RTPP connectivity solution is implemented as a suite of global Java operators that allow a Spotfire Streaming application to connect to an RTPP client or server, and exchange messages with that counterparty. The adapter conforms to version 1.1 of the RTPP protocol, and fully supports the following products:

The different RTPP Client operators can be made to share a connection to the server (and and conversely, RTPP Server operators can be made to share the same connections to clients), provided they are configured to do so. Each operator lists the connection configurations available in corresponding combo box settings (see Properties: Operator Properties Tab). The lists are specified in a dedicated section of the application's adapter configuration file. The following example is the RTPP.conf file used in the RTPP sample:

name = "RTPP.conf"
type = "com.tibco.ep.streambase.configuration.adapter"
version = "1.0.0"
configuration = {

  // An adapter group type defines a collection of EventFlow adapter configurations, 
  // indexed by adapter type.
  AdapterGroup = {

    // A collection of EventFlow adapter configurations, indexed by adapter type. 
    // This key is required and must contain at least one configuration.
    adapters = {

      // The root section for the configurations for the RTPP adapters.
      rtpp-adapters = {

        // Section list. This key is optional and has no default value.
        sections = [

          // A configuration for a named section for this adapter.
          {

            // Section name. The value does not have to be unique; that is, you can have 
            // multiple sections with the same name in the same array of sections. This key 
            // is required.
            name = "rtpp-connection"

            // Section property bag. All values must be strings. This key is optional 
            // and has no default value.
            settings = {
              id = "RTPPSampleClient"
              host = "127.0.0.1"
              port= "51234"
              connect-on-startup = "true"
              enable-automatic-reconnection = "true"
              reconnection-attempts = "3" // Anything < 1 means infinite retries
              reconnection-attempt-interval = "3000" // In ms
              echo-interval = "50000" // In ms

              // This directs the adapter to convert RTPP parameters of type OCTETSTRING
              // to a Base64-endoded, TIBCO Streaming type STRING instead of BLOB. Defaults to "true".
              treat-octetstring-as-base64string = "true"

              // This determines how the TransactionID header field is represented:
              // "HexString" -- Default. A String field containing the hex representation of the 16 bytes of the ID (e.g. '10203040506070809000A0B0C0D0E0F0')
              // "Base64String" -- A String field containing the base64 conversion of the 16 bytes of the ID
              // "Blob" -- A Blob field containing the raw 16 bytes of the ID
              transaction-id-handling = "HexString"

              // When set to true, this will add message receipt timestamp fields to the Input adapters' results port. Default to "false".
              add-receipt-timestamps = "false"
              
              //message-buffer-size = "65536" // In bytes
            }
          }

          // A configuration for a second named section for this adapter.
          {
            name = "rtpp-connection"

            settings = {
              id = "RTPPSampleServer"
              port = "51234"
              connect-on-startup = "true"
              idle-connection-timeout = "60000" // In ms  

              // This directs the adapter to convert RTPP parameters of type OCTETSTRING
              // to a Base64-endoded, TIBCO Streaming type STRING instead of BLOB. Defaults to "true".
              treat-octetstring-as-base64string = "true"
              
              // This determines how the TransactionID header field is represented:
              // "HexString" -- Default. A String field containing the hex representation of the 16 bytes of the ID (e.g. '10203040506070809000A0B0C0D0E0F0')
              // "Base64String" -- A String field containing the base64 conversion of the 16 bytes of the ID
              // "Blob" -- A Blob field containing the raw 16 bytes of the ID
              transaction-id-handling = "HexString"

              // When set to true, this will add message receipt timestamp fields to the Input adapters' results port. Default to "false".
              add-receipt-timestamps = "false"
              
              //message-buffer-size = "65536" // In bytes
            }
          }
        ]
      }
    }
  }
}

In each section named rtpp-connection, the value of the id setting identifies this particular section (in other words, this particular connection definition) and will be listed in the Operator Properties tab's Adapter Configuration drop-down setting in each operator's Properties view. Multiple operators can be made to share a single connection by using the same value for this Adapter Configuration setting.

A best practice is to define your connections before placing operator instances on the canvas, so that the list is already available in the Properties view and the operators can be configured right away.

This section describes the properties you can set for an RTPP operator, using the various tabs of the Properties view in StreamBase Studio.

Every operator (Client and Server Control, Input and Output) have a Status output port used to issue various informational and error messages:

The table below lists all the RTPP data types and their translation to a corresponding Spotfire Streaming data type.

The Spotfire Streaming installation comes with a sample demonstrating the use of this adapter. To load the sample in Streaming Studio, select File>Import Samples and Community Content and look under the Messaging Adapters category for an entry called RTPP Adapter.

Back to Top ^