Caplin.DataSource.Channel.IJsonChannel Interface Reference

Inherited by Caplin.DataSource.Channel.JsonChannel.

Public Member Functions
String	getSubject ()
void	send (Object obj)
void	sendSubjectError (String subject, SubjectError error)
void	sendSubjectStatus (String subject, SubjectStatus subjectStatus, String statusMessage)

Detailed Description

Represents a JSON channel to a subject on the Liberator.

A Channel provides a bi-directional communication channel between a DataSource adapter and a StreamLink application. 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

String Caplin.DataSource.Channel.IJsonChannel.getSubject

(

)

Returns the subject name to which the channel relates.

Returns

The subject of this channel.

void Caplin.DataSource.Channel.IJsonChannel.send

(

Object

obj

)

Sends object as JSON to the channel subject

Parameters

obj	the object to send in JSON format (using the installed JsonHandler to serialize the object to JSON)

void Caplin.DataSource.Channel.IJsonChannel.sendSubjectError	(	String	subject,
		SubjectError	error
	)

Sends a subject error event to the peer that opened the channel.

Parameters

subject	The subject to send the subject error to.
error	The SubjectError to be sent.

void Caplin.DataSource.Channel.IJsonChannel.sendSubjectStatus	(	String	subject,
		SubjectStatus	subjectStatus,
		String	statusMessage
	)

Sends a subject Status event to the peer that opened the channel.

Parameters

subject	The subject to send the subject error to.
statusMessage	The statusMessage to send to the peer.
subjectStatus	The SubjectStatus to be sent.