Package PushTechnology.ClientInterface.Client.Types

Classes
class	Constants
	Constants used within Diffusion. More...
class	DeliveryType
	Content delivery type. More...
interface	IClientEndpoint
	Interface for any client end point to which content may be sent. More...
interface	IDeliveryContext
	Context of content received. More...
interface	IDeliveryOptionsBuilder< out T >
	The delivery options builder interface. More...
interface	IErrorReport
	An error report. More...
interface	IPermission
	A permission protects an access-controlled operation. More...
interface	IReceiveContext
	The context of content received. More...
interface	ISendOptionsBuilderFactory
	The factory for send options builders. More...
interface	ITopicSendOptions
	Options associated with sending content. More...
interface	ITopicSendOptionsBuilder
	The send options builder. More...
interface	IUpdateContext
	Context of a content update. More...
class	TopicUpdateType
	Topic update type. More...

Enumerations
enum	GlobalPermission {   GlobalPermission.AUTHENTICATE, GlobalPermission.VIEW_SESSION, GlobalPermission.MODIFY_SESSION, GlobalPermission.REGISTER_HANDLER,   GlobalPermission.VIEW_SERVER, GlobalPermission.CONTROL_SERVER, GlobalPermission.VIEW_SECURITY, GlobalPermission.MODIFY_SECURITY }
	Permissions that protected globally scoped, access-controlled operations. There is no related object - permission is granted globally. More...
enum	TopicPermission {   TopicPermission.READ_TOPIC, TopicPermission.UPDATE_TOPIC, TopicPermission.MODIFY_TOPIC, TopicPermission.SEND_TO_MESSAGE_HANDLER,   TopicPermission.SEND_TO_SESSION, TopicPermission.SELECT_TOPIC, TopicPermission.QUERY_OBSOLETE_TIME_SERIES_EVENTS, TopicPermission.EDIT_TIME_SERIES_EVENTS,   TopicPermission.EDIT_OWN_TIME_SERIES_EVENTS }
	Permissions that protect access-controled operations that are evaluated for a specific topic path. More...

Enumeration Type Documentation

enum PushTechnology.ClientInterface.Client.Types.GlobalPermission

Permissions that protected globally scoped, access-controlled operations. There is no related object - permission is granted globally.

Enumerator
AUTHENTICATE	Add an authentication handler.
VIEW_SESSION	List or listen to client sessions.
MODIFY_SESSION	Alter a client session. This covers a range of actions including: Subscribe session to topic Throttle session Enable conflation for session Close session
REGISTER_HANDLER	Required to register any server-side handler. This restricts client from consuming resources by registering long-lived handlers (e.g. AddMessageHAndler). Typically these would never be called due to lack of other permissions.
VIEW_SERVER	View the server's runtime state - e.g. read JMX MBeans.
CONTROL_SERVER	Change the server's runtime state, e.g. shut it down.
VIEW_SECURITY	Read the security configuration.
MODIFY_SECURITY	Change the security configuration.

enum PushTechnology.ClientInterface.Client.Types.TopicPermission

Permissions that protect access-controled operations that are evaluated for a specific topic path.

Also see GlobalPermission.

Enumerator
READ_TOPIC	Required to receive information from a topic. If a session does not have read_topic permission for a topic, the topic will be excluded from the results of subscription or fetch operations for the session, and the topic's details cannot be retrieved by the session.
UPDATE_TOPIC	Update a topic.
MODIFY_TOPIC	Add or remove a topic.
SEND_TO_MESSAGE_HANDLER	Send a topic message to the server.
SEND_TO_SESSION	Send a topic message to a client session.
SELECT_TOPIC	Use a topic selector that selects the topic path. A session must have this permission for the path prefix of any topic selector used to subscribe or fetch. When the subscription or fetch request completes, the resulting topics are further filtered based on the READ_TOPIC permission. A session that has READ_TOPIC but not SELECT_TOPIC for a particular topic path cannot subscribe directly to topics belonging to the path. However, the session can be independently subscribed by a control session that has GlobalPermission.MODIFY_SESSION permission in addition to the relevant SELECT_TOPIC permission. Since 5.7.
QUERY_OBSOLETE_TIME_SERIES_EVENTS	Evaluate queries that return a non-current view of a time series topic. The permission is required to evaluate any type of query for a time series topic. This permission is additionally required for queries that potentially return a non-current view of all or part of a time series. Such queries include value range queries that specify an edit range, and all types of edit range query. Since 6.0
EDIT_TIME_SERIES_EVENTS	Submit edits to time series topic events. The permission is required to update a time series topic. This permission is additionally required to submit edits to a time series topic. Since 6.0
EDIT_OWN_TIME_SERIES_EVENTS	Submit edits to time series topic events which have an author which is the same as the principal of the calling session. This permission is a more restrictive alternative to . The #UPDATE_TOPIC} permission is required to update a time series topic. This permission is additionally required to submit edits to a time series topic where the event author is the same as the principal of the calling session. Since 6.0