Namespace PushTechnology.ClientInterface.Client.Features.Control.Clients

Classes

QueueEventHandlerDefault

Provides a default handler implementation which will simply log client state events.

RemoteServerExistsException

Exception thrown when an attempt has been made to create a remote server when one with the same name is already defined.

RemoteServerOptionsException

Exception thrown when one or more of the options specified when creating a remote server have been found to be invalid.

SessionPropertiesListenerDefault

This provides a default implementation of ISessionPropertiesListener which will simply log session properties callbacks at debug level. This should only be used for diagnostic purposes.

Interfaces

IAuthenticationControl

This feature allows a client session to authenticate the credentials of other sessions.

ICheckRemoteServerResult

Result returned from a CheckRemoteServerAsync(String) invocation.

IClientCallback

Callback interface for Close(ISessionId, IClientCallback), and SetConflated(ISessionId, Boolean, IClientCallback).

Provides notifications of whether the requested operation was handled by the server.

IClientContextCallback<TContext>

Contextual version of IClientCallback.

Attaches an arbitrary context object to callback notifications.

IClientControl

This feature provides the ability for a client session to control other client sessions.

IConfigurationCallback

The callback interface for GetSystemAuthentication(IConfigurationCallback).

IConfigurationContextCallback<TContext>

The callback interface for GetSystemAuthentication<TContext>(TContext, IConfigurationContextCallback<TContext>).

IControlAuthenticator

The control authenticator.

IMatchesSessionPropertyValidation

Defines regular expression based validation for a trusted client proposed session property.

IPrimaryInitiator

A primary initiator.

IPrimaryInitiatorBuilder

Builder for a IPrimaryInitiator.

A builder of this type may be created using NewRemoteServerBuilder(RemoteServerType) specifying RemoteServerType.PRIMARY_INITIATOR as the parameter.

IQueueEventHandler

Handler for client queue events.

IRemoteServer

Base interface for a Remote Server definition.

IRemoteServerBuilder

Interface for a remote server builder. Since 6.7.

A builder of this type may be created using NewRemoteServerBuilder() and used to create instances of IRemoteServer that can be supplied to CreateRemoteServerAsync(IRemoteServer).

IRemoteServerBuilder<T>

The base interface for all remote server builders.

A builder of this type cannot be instantiated.

IRemoteServerDefinition

Interface for a full remote server specification including credentials.

Added in version 6.5.

IRemoteServers

This feature allows a client session to manage remote servers.

IScriptBuilder

The script builder used to create a script of commands to apply to the system authentication store at the server.

ISecondaryAcceptor

Secondary remote server that accepts a connection from a primary server.

This type accepts a connection from a IPrimaryInitiator with the same name configured at the primary server (cluster).

Use a ISecondaryAcceptorBuilder to create an instance of this type.

ISecondaryAcceptorBuilder

Builder for a ISecondaryAcceptor.

A builder of this type may be created using NewRemoteServerBuilder(RemoteServerType) specifying RemoteServerType.SECONDARY_ACCEPTOR as the parameter.

ISecondaryBuilder<T>

Base builder interface for ISecondaryServer.

A builder of this type cannot be instantiated.

ISecondaryInitiator

Secondary remote server that initiates a connection to a primary server.

This type makes a connection from a secondary server (or each secondary cluster member) to a primary server. No remote server definition is required at the primary server.

Use a ISecondaryInitiatorBuilder to create an instance of this type.

ISecondaryInitiatorBuilder

Builder for a ISecondaryInitiator.

A builder of this type may be created using NewRemoteServerBuilder(RemoteServerType) specifying RemoteServerType.SECONDARY_INITIATOR as the parameter.

ISecondaryServer

Base interface for a secondary remote server.

ISessionPropertiesContextCallback<TC>

Contextual callback interface for GetSessionProperties<TC>(ISessionId, List<String>, TC, ISessionPropertiesContextCallback<TC>).

Used to associate some arbitrary context object with each call.

ISessionPropertiesListener

The handler for session properties listener notifications.

This is used along with SetSessionPropertiesListener(ISessionPropertiesListener, String[]) to obtain notifications for client sessions.

Callbacks with a properties parameter will provide a map of the property values requested when registering the listener.

ISessionPropertyValidation

Defines the validation for a trusted client proposed session property.

ISystemAuthenticationConfiguration

The snapshot of information from the system authentication store.

ISystemAuthenticationControl

The system authentication control feature that allows a client session to query and update the system authentication store.

ISystemPrincipal

The principal in the system authentication store.

IValuesSessionPropertyValidation

Defines values based validation for a trusted client proposed session property.

Enums

AnonymousConnectionAction

The action to be taken by the system authentication handler for connection attempts that do not provide a principal name and credentials.

RemoteServerConnectionOption

Connection options for use with ISecondaryServer.

RemoteServerConnectionState

Represents the current connection state of the remote server.

RemoteServerType

The remote server type.

SessionPropertiesListenerEventType

The session properties listener event type enumeration.