PushTechnology.ClientInterface.Client.Session.ISession Interface Reference

A client session with a server or servers. More...

Public Member Functions
void	Start ()
	Starts the session. More...
void	Close ()
	Close the session. More...
ITopics	GetTopicsFeature ()
	Gets the 'Topics' feature. More...
IPings	GetPingFeature ()
	Gets the 'Ping' feature. More...
ITopicControl	GetTopicControlFeature ()
	Gets the 'Topic Control' feature. More...
ISubscriptionControl	GetSubscriptionControlFeature ()
	Gets the 'Subscription Control' feature. More...
IAuthenticationControl	GetAuthenticationControlFeature ()
	Gets the 'Authentication Control' feature. More...
ISystemAuthenticationControl	GetSystemAuthenticationControlFeature ()
	Gets the 'System Authentication Control' feature. More...
ISecurity	GetSecurityFeature ()
	Gets the 'Security' feature. More...
ITopicUpdateControl	GetTopicUpdateControlFeature ()
	Gets the 'Topic Update Control' feature. More...
IMessaging	GetMessagingFeature ()
	Gets the 'Messaging' feature. More...
IMessagingControl	GetMessagingControlFeature ()
	Gets the 'Messaging Control' feature. More...
IClientControl	GetClientControlFeature ()
	Gets the 'Client Control' feature. More...
ISecurityControl	GetSecurityControlFeature ()
	Gets the 'Security Control' feature. More...

Properties
SessionId	SessionId [get]
	Returns the unique identifier for the session as assigned by the (first) server it connects to. More...
string	Principal [get]
	Returns the name of the security principal associated with the session. More...
ISessionAttributes	Attributes [get]
	Returns the session attributes. More...
SessionState	State [get]
	Returns the current state of the session. More...

Events
EventHandler < SessionListenerEventArgs >	StateChanged
	Notifies when the session state changes. More...
EventHandler < SessionErrorHandlerEventArgs >	ErrorNotified
	Notifies when an error occurs. More...

Detailed Description

A client session with a server or servers.

To open a new session connection to a server, use ISessionFactory.Open(string) specifying the server url. There is also a non-blocking version ISessionFactory.Open(string,ISessionOpenCallback) which calls back when the session has been connected.

The factory allows a number of other attributes of the session to be specified.

The functionality of a session is exposed to the application by getting the required feature(s) using the various retrieval methods.

For each session there is a single instance of each feature which may be obtained and used at any time.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Session.ISession.Close

(

)

Close the session.

Has no effect if the session is already closed.

IAuthenticationControl PushTechnology.ClientInterface.Client.Session.ISession.GetAuthenticationControlFeature

(

)

Gets the 'Authentication Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The subscription control feature.

IClientControl PushTechnology.ClientInterface.Client.Session.ISession.GetClientControlFeature

(

)

Gets the 'Client Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The client control feature.

IMessagingControl PushTechnology.ClientInterface.Client.Session.ISession.GetMessagingControlFeature

(

)

Gets the 'Messaging Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The messaging control feature.

IMessaging PushTechnology.ClientInterface.Client.Session.ISession.GetMessagingFeature

(

)

Gets the 'Messaging' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The messaging feature.

IPings PushTechnology.ClientInterface.Client.Session.ISession.GetPingFeature

(

)

Gets the 'Ping' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The ping feature.

ISecurityControl PushTechnology.ClientInterface.Client.Session.ISession.GetSecurityControlFeature

(

)

Gets the 'Security Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The security control feature.

ISecurity PushTechnology.ClientInterface.Client.Session.ISession.GetSecurityFeature

(

)

Gets the 'Security' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The subscription control feature.

ISubscriptionControl PushTechnology.ClientInterface.Client.Session.ISession.GetSubscriptionControlFeature

(

)

Gets the 'Subscription Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The subscription control feature.

ISystemAuthenticationControl PushTechnology.ClientInterface.Client.Session.ISession.GetSystemAuthenticationControlFeature

(

)

Gets the 'System Authentication Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

ITopicControl PushTechnology.ClientInterface.Client.Session.ISession.GetTopicControlFeature

(

)

Gets the 'Topic Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The subscription control feature.

ITopics PushTechnology.ClientInterface.Client.Session.ISession.GetTopicsFeature

(

)

Gets the 'Topics' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The topics feature.

ITopicUpdateControl PushTechnology.ClientInterface.Client.Session.ISession.GetTopicUpdateControlFeature

(

)

Gets the 'Topic Update Control' feature.

This may be used to get the feature and it will automatically instantiate the feature the first time it is called.

Returns

The topic update control feature.

void PushTechnology.ClientInterface.Client.Session.ISession.Start

(

)

Starts the session.

Has no effect if the session is already started.

Property Documentation

ISessionAttributes PushTechnology.ClientInterface.Client.Session.ISession.Attributes

get

Returns the session attributes.

string PushTechnology.ClientInterface.Client.Session.ISession.Principal

get

Returns the name of the security principal associated with the session.

SessionId PushTechnology.ClientInterface.Client.Session.ISession.SessionId

get

Returns the unique identifier for the session as assigned by the (first) server it connects to.

SessionState PushTechnology.ClientInterface.Client.Session.ISession.State

get

Returns the current state of the session.

Event Documentation

EventHandler<SessionErrorHandlerEventArgs> PushTechnology.ClientInterface.Client.Session.ISession.ErrorNotified

Notifies when an error occurs.

EventHandler<SessionListenerEventArgs> PushTechnology.ClientInterface.Client.Session.ISession.StateChanged

Notifies when the session state changes.

---

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

• UCIStack/Client/Session/ISession.cs