Caplin.StreamLink.ICommandParameters Interface Reference

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

Public Member Functions
Caplin.StreamLink.ICommandParameters	AddHeader (string name, string value)
	For REST operations this adds a HTTP header to be used by the resulting REST request. The order in which the headers are More...
Caplin.StreamLink.ICommandParameters	SetCancellable ()
	Sets the command associated with a CommandSubscription to be cancelled in the More...
Caplin.StreamLink.ICommandParameters	SetPayload (object obj)
Caplin.StreamLink.ICommandParameters	SetPayloadType (Caplin.StreamLink.PayloadType type)
Caplin.StreamLink.ICommandParameters	SetPersistent ()
	Sets the command associated with a CommandSubscription to be persistent. More...

Properties
object	Payload [get]
Caplin.StreamLink.PayloadType	PayloadType [get]

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.AddHeader	(	string	name,
		string	value
	)

For REST operations this adds a HTTP header to be used by the resulting REST request. The order in which the headers are

** added will be the order in which they are applied to the REST operation.

• Parameters

  name	the name of the HTTP header

• Parameters

  value

  the value of the header

• Returns

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

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.SetPayload

(

object

obj

)

• Sets the payload object, this should be of the type specified in the payload type.

• Parameters

  obj	the payload ojbject

Caplin.StreamLink.ICommandParameters Caplin.StreamLink.ICommandParameters.SetPayloadType

(

Caplin.StreamLink.PayloadType

type

)

• Sets the type of the payload

• Parameters

  type	the payload type

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).

Property Documentation

object Caplin.StreamLink.ICommandParameters.Payload

get

• Gets the payload
• the payload

Caplin.StreamLink.PayloadType Caplin.StreamLink.ICommandParameters.PayloadType

get

• Gets the payload type
• the payload type