<SLChannel > Protocol Reference

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

Inheritance diagram for <SLChannel >:

Instance Methods
(NSString *)	- subject
	Returns the subject name to which the channel relates. More...
(void)	- 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. More...
(void)	- sendFields:commandListener:
	Sends fields to the channel subject. More...
(void)	- sendFieldList:commandListener:
	Sends fields to the channel subject. More...

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.

Method Documentation

- (void SLChannel) 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 SLChannel) sendFieldList:		(NSArray< SLPair< NSString *, NSString * > * > *)	fieldValues
commandListener:		(id< SLCommandListener >)	commandListener

Sends fields to the channel subject.

Parameters

fieldValues	the fields to send
commandListener	optional callback for command completion (can be set to nil).

- (void SLChannel) sendFields:		(NSDictionary< NSString *, NSString * > *)	fieldValues
commandListener:		(id< SLCommandListener >)	commandListener

Sends fields to the channel subject.

Parameters

fieldValues	the fields to send
commandListener	optional callback for command completion (can be set to nil).

- (NSString * SLChannel) subject

Returns the subject name to which the channel relates.

Returns

The subject of this channel.