Caplin.StreamLink.ICommandParameters Interface Reference

Interface that defines parameters for a ICommandSubscription. More...

Public Member Functions
Caplin.StreamLink.ICommandParameters	SetCancellable ()
	Sets the command associated with a CommandSubscription to be cancelled in the event that the connection goes down before it is sent. More...
Caplin.StreamLink.ICommandParameters	SetPersistent ()
	Sets the command associated with a CommandSubscription to be persistent. This deals with the situation where the connection to the Liberator server has been lost, and on subsequent reconnection StreamLink must create a brand new user session and log in to Liberator again. When this happens, the "persistent" command is automatically re-sent to the Liberator. More...

Detailed Description

Interface that defines parameters for a ICommandSubscription.

The interface currently allows you to define a just a single parameter that makes the command persistent.

You can create an instance of this interface by calling createCommandParameters() on a com.caplin.streamlink.StreamLink instance. Then, after setting up the parameters you can apply to a command by passing into the appropriate publish(), create() etc method on the IStreamLink object.

Member Function Documentation

Caplin.StreamLink.ICommandParameters Caplin.StreamLink.ICommandParameters.SetCancellable

(

)

Sets the command associated with a CommandSubscription to be cancelled in the event that the connection goes down before it is sent.

The updated CommandParameters object (to permit a fluent programming style).

Caplin.StreamLink.ICommandParameters Caplin.StreamLink.ICommandParameters.SetPersistent

(

)

Sets the command associated with a CommandSubscription to be persistent. This deals with the situation where the connection to the Liberator server has been lost, and on subsequent reconnection StreamLink must create a brand new user session and log in to Liberator again. When this happens, the "persistent" command is automatically re-sent to the Liberator.

The updated CommandParameters object (to permit a fluent programming style).