PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession Interface Reference

Representation of a client session. More...

Public Member Functions
IClientSession	SetQueueThresholds (int lower, int upper)
	Sets queue notification thresholds for the client. More...
IClientSession	Throttle (ThrottlerType type, int limit)
	Throttle the client. More...
IClientSession	RemoteThrottle ()
	Remove any existing throttle. More...
IClientSession	StartConflating ()
	Start conflating all messages queued for the client. More...
IClientSession	StopConflating ()
	Stop conflating. More...
void	Close (CloseReason reason)
	Close a client session. More...

Properties
SessionId	Identity [get]
	Returns the client's session identity. More...
IClientInfo	ClientInfo [get]
	Returns the client information. More...

Detailed Description

Representation of a client session.

Member Function Documentation

void PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.Close

(

CloseReason

reason

)

Close a client session.

Parameters

reason

The reason for closing the client session.

IClientSession PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.RemoteThrottle

(

)

Remove any existing throttle.

Returns

The client session.

IClientSession PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.SetQueueThresholds	(	int	lower,
		int	upper
	)

Sets queue notification thresholds for the client.

The upper threshold is a percentage of the maximum queue size at which a notification should occur when a message is added to the queue causing its size to reach the threshold. If this is -1 then no upper threshold notification is used.

The lower threshold is a percentage of the maximum queue size at which a notification should occur when a message is removed from the queue causing the queue size to reach the threshold if (and only if) the upper threshold has been breached. If this is -1 then no lower threshold notification would occur.

Parameters

lower	value between 0 and 99, or -1 to indicate no lower threshold notification is required. This value would be ignored if upper was set to -1.
upper	A value between 1 and 100, or -1 to indicate no upper threshold notification is required.

Returns

The client session.

IClientSession PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.StartConflating

(

)

Start conflating all messages queued for the client.

Returns

The client session.

IClientSession PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.StopConflating

(

)

Stop conflating.

Returns

The client session.

IClientSession PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.Throttle	(	ThrottlerType	type,
		int	limit
	)

Throttle the client.

Throttling a client queue causes a message limit to be imposed which restricts messages sent to the client.

If the client is already throttled then this has the effect of removing the existing throttler and creating a new one.

Parameters

type	Indicates the type of throttling required.
limit	Indicates the throttling limit. The meaning of this limit depends upon the throttling type.

Returns

The client session.

Property Documentation

IClientInfo PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.ClientInfo

get

Returns the client information.

SessionId PushTechnology.ClientInterface.Client.Features.Control.Clients.IClientSession.Identity

get

Returns the client's session identity.

---

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

• UCIStack/Client/Features/Control/Clients/IClientSession.cs