StreamLink.NET  7.1.20-7.1.20-1045-9572bb5
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Public Member Functions | Properties | List of all members
Caplin.StreamLink.IChannel Interface Reference

Represents a channel to a subject on the Liberator. More...

Public Member Functions

void CloseChannel ()
 
void Send (IDictionary< string, string > fields, Caplin.StreamLink.ICommandListener commandListener)
 
void SendWithFieldList (IList< Caplin.StreamLink.STuple > fields, Caplin.StreamLink.ICommandListener commandListener)
 

Properties

string Subject [get]
 

Detailed Description

Represents a channel to a subject on the Liberator.

A Channel provides a bi-directional communication channel between a StreamLink application and a DataSource adapter. Using a Channel in both DataSource and StreamLink provides a simplified method of communication between the two components and can allow you just to use the Caplin platform as a bi-directional messaging pipe.

Member Function Documentation

void Caplin.StreamLink.IChannel.CloseChannel ( )
  • Closes the channel to the Liberator. This will result in a corresponding call to onChannelClose
  • declared in ChannelListener on the DataSource. The delay before onChannelClose is called is defined by the
  • Liberator configuration item, active-discard-timeout.
void Caplin.StreamLink.IChannel.Send ( IDictionary< string, string >  fields,
Caplin.StreamLink.ICommandListener  commandListener 
)
  • Sends fields to the channel subject
  • Parameters
    fieldsthe fields to send
  • Parameters
    commandListeneroptional callback for command completion (can set to null).
void Caplin.StreamLink.IChannel.SendWithFieldList ( IList< Caplin.StreamLink.STuple fields,
Caplin.StreamLink.ICommandListener  commandListener 
)
  • Sends fields to the channel subject allowing for a field to be repeatedly specified in the same message.
  • Parameters
    fieldsthe fields to send. Note: for Javascript this should be a JSON object of the form
  • [{field1:"value1"}, {field2:"value2"}, {field3:"value3"}]
  • Parameters
    commandListeneroptional callback for command completion (can set to null).

Property Documentation

string Caplin.StreamLink.IChannel.Subject
get
  • Returns the subject name to which the channel relates.
  • The subject of this channel.

Generated on Wed Nov 22 2023 10:13:09 for StreamLink.NET