DEPRECATED: Diffusion Silverlight Classic API  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.Transports.DiffusionSocket Class Reference

Represents a socket connection to a Diffusion server. More...

Inheritance diagram for PushTechnology.Transports.DiffusionSocket:

Public Member Functions

 DiffusionSocket (string host, int port, string topic, int maxBufferSize, bool cascade)
 Constructor. More...
 
void Connect (string host, int port, string topic)
 
void Disconnect ()
 
string SendReceiveTextToSocketClient (string text)
 
void SendTextToSocketClient (string text)
 Send a string to a connected socket. More...
 
void Send (byte[] buffer)
 Send a sequence of bytes to the Diffusion server. More...
 
void Dispose ()
 

Protected Member Functions

virtual void DoPostConnectionProcessing (SocketAsyncEventArgs e)
 Performs post-connection activities including gathering the client id. More...
 
virtual ByteBuffer GetInitialResponse ()
 
virtual ByteBuffer WriteRegistrationHeader ()
 
virtual void FinalisePostProcessing (ByteBuffer initialResponse)
 Called when we have a complete initial response buffer. More...
 

Properties

bool IsConnected [get]
 Is the socket connected? More...
 
bool Cascade [get, set]
 Flag to indicate a transport cascade. More...
 
DiffusionClientCredentials Credentials [get, set]
 The login credentials for the connection. More...
 
string Host [get, set]
 The host address of the Diffusion server. More...
 
int Port [get, set]
 The port of the Diffusion server. More...
 
string Topic [get, set]
 The topics to subscribe to on the Diffusion server. More...
 
string ClientId [get, set]
 The allocated client id. More...
 
int ServerProtocolVersion [get, set]
 

Detailed Description

Represents a socket connection to a Diffusion server.

Constructor & Destructor Documentation

PushTechnology.Transports.DiffusionSocket.DiffusionSocket ( string  host,
int  port,
string  topic,
int  maxBufferSize,
bool  cascade 
)

Constructor.

Parameters
host
port
topic
maxBufferSize
cascade

Member Function Documentation

void PushTechnology.Transports.DiffusionSocket.Connect ( string  host,
int  port,
string  topic 
)
void PushTechnology.Transports.DiffusionSocket.Disconnect ( )
void PushTechnology.Transports.DiffusionSocket.Dispose ( )
virtual void PushTechnology.Transports.DiffusionSocket.DoPostConnectionProcessing ( SocketAsyncEventArgs  e)
protectedvirtual

Performs post-connection activities including gathering the client id.

virtual void PushTechnology.Transports.DiffusionSocket.FinalisePostProcessing ( ByteBuffer  initialResponse)
protectedvirtual

Called when we have a complete initial response buffer.

Parameters
initialResponse
virtual ByteBuffer PushTechnology.Transports.DiffusionSocket.GetInitialResponse ( )
protectedvirtual
void PushTechnology.Transports.DiffusionSocket.Send ( byte[]  buffer)

Send a sequence of bytes to the Diffusion server.

Parameters
buffer
string PushTechnology.Transports.DiffusionSocket.SendReceiveTextToSocketClient ( string  text)
void PushTechnology.Transports.DiffusionSocket.SendTextToSocketClient ( string  text)

Send a string to a connected socket.

Parameters
text
virtual ByteBuffer PushTechnology.Transports.DiffusionSocket.WriteRegistrationHeader ( )
protectedvirtual

Property Documentation

bool PushTechnology.Transports.DiffusionSocket.Cascade
getset

Flag to indicate a transport cascade.

string PushTechnology.Transports.DiffusionSocket.ClientId
getset

The allocated client id.

DiffusionClientCredentials PushTechnology.Transports.DiffusionSocket.Credentials
getset

The login credentials for the connection.

string PushTechnology.Transports.DiffusionSocket.Host
getset

The host address of the Diffusion server.

bool PushTechnology.Transports.DiffusionSocket.IsConnected
get

Is the socket connected?

int PushTechnology.Transports.DiffusionSocket.Port
getset

The port of the Diffusion server.

int PushTechnology.Transports.DiffusionSocket.ServerProtocolVersion
getset
string PushTechnology.Transports.DiffusionSocket.Topic
getset

The topics to subscribe to on the Diffusion server.


The documentation for this class was generated from the following file: