Protocol
objects
used by applications developed with the Platform SDKs.
Protocol
objects that you can use
to handle server connections when using the Platform SDK. Please refer to the information
there and to the Protocols
package associated with the particular server you
need to connect with. For example, if you are working with Stat Server, you would look
at the documentation for com.genesyslab.platform.reporting.protocol
.
Interface | Description |
---|---|
AsyncChannel |
Communication channel.
|
AsyncChannelOperations |
Asynchronous operations.
|
AsyncInvokerSupport | |
Channel |
Communication channel with synchronous opening and closing.
|
ChannelListener | |
ChannelListenerSupport | |
ChannelManagerMBean | |
ClientChannel.ClientHandshakeStep |
Interface representing client side step of a protocol handshake procedure.
|
ClientChannel.RegistrationHandler | Deprecated. |
ClientChannelManagerMBean | |
ClientRequestHandler |
Interface for client request handling.
|
ConfigurationSupport | |
ConnectionInvokerSupport | Deprecated. |
ConnectionOperations |
Provides API for exclusive access to channel's connection operations.
|
EndpointSupport | |
ExternalTransport |
Describes API of external transport.
|
ExternalTransportFactory |
Factory of external transport for a specified protocol description and an endpoint.
|
ExternalTransportListener |
API for external transport events handling.
|
InputChannel | |
InterceptorSupport | |
Listener |
Marker interface for event listeners.
|
ListenerHelper.NotificationVisitor | |
LogMessageFilterSupport |
Interface which provide possibilty to change message logining filter.
|
MessageCorrelator.MessageEntry | |
MessageFilter |
Filtering messages interface.
|
MessageHandler |
Interface for direct incoming messages delivery to user code.
Example:
|
MessageParser.ErrorHandler | |
MessageReceiver<T> |
Message receiver is going to be deprecated.
|
MessageReceiverManagement | |
MessageReceiverSupport | |
OutputChannel | |
OutputChannelListener |
Defines listener that can be attached to any implementer of OutputChannel interface to monitor message send operations.
|
Protocol |
Protocol is Input/Output Synchronous/Asynchronous channel.
|
ProtocolDescriptionSupport | |
ProtocolFactory | |
ProtocolFactory.MessageVerificationSupport |
Verifies message to use it.
|
Receiver | |
ReceiverManagement | |
ReceiverSupport | |
Referenceable |
Messages that participate in "conversations" (need to connect responses
with requests) should implement this interface to support ReferenceBuilders
of their protocols.
|
ReferenceBuilder | |
RequestChannel | |
RequestContext | |
RequestFuture | |
RequestReceiver | |
RequestReceiverManagement | |
RequestReceiverSupport | |
ResponseChannel | |
ServerChannelListener |
Receive notification about server channel lifecycle events.
|
ServerChannelManagerMBean |
Class | Description |
---|---|
AbstractChannel | |
AbstractProtocolFactory | |
AbstractQueueReceiver<T> | |
AbstractReferenceBuilder | |
ChannelClosedEvent | |
ChannelErrorEvent | |
ChannelOpenedEvent | |
ChannelState |
This enum defines all possible channel states.
|
ClientChannel |
ClientChannel is the parent class of all of the
Protocol classes used for client applications
in the Platform SDK, such as TServerProtocol and
ConfServerProtocol . |
ClientChannelHandler |
Base class for incoming clients connections channels on ServerChannel.
|
ClientChannelHandlerFactory |
Common base factory class for creation of client handling channels.
It may be overridden in specific protocols for custom initialization of channels, their connections or transport properties. |
DataObject | |
DuplexChannel |
Allows for asynchronous two-way communication between a Platform SDK
application and a server.
|
Endpoint |
You can use an
Endpoint to describe a server that
your application will be communicating with, by giving the server's
name, host, port, and optionally connection configuration. |
EnumDescriptions | |
IgnoringMessageReceiverSupport | |
IntReferenceBuilder | |
ListenerHelper | |
Message |
This abstract class provides the interface used for all
Event
classes. |
MessageCorrelator |
For Genesys Platform SDK internal use only.
|
MessageParser |
This class can be used for manual extracting Message object from byte array.
|
ProtocolDescription | |
QueueMessageReceiver | |
QueueRequestReceiver | |
ServerChannel |
This channel accepts client connections on given local
Endpoint .Method AbstractChannel.addChannelListener(ChannelListener) accepts ServerChannelListener ,
which provides notifications on incoming clients. |
UriInfo | Deprecated.
for internal use only.
|
WildcardEndpoint |
A special case of Endpoint that allows user to specify wildcard address for a server socket.
|
XmlMessageSerializer |
Enum | Description |
---|---|
ProtocolFactory.MessageVerificationReason |
Describes possible reasons of verification.
|
Exception | Description |
---|---|
BlockedChannelNotificationThreadException |
It is thrown when called some blocked operation inside channel notification thread
and thus this operation can't be completed successfully because channel thread is blocked.
|
ChannelClosedOnCloseException |
This exception is thrown when close attempt on closed channel (not opened) occurs.
|
ChannelClosedOnRequestException |
This exception is thrown when close attempt on channel request occurs.
|
ChannelClosedOnSendException |
This exception is thrown when send attempt of some data on closed channel (not opened) occurs.
|
ChannelEmergencyClosedException |
ChannelEmergencyClosedException throws if a protocol closed while it opening.
|
ChannelNotClosedException |
This exception is thrown when action acceptable for not opened channel occurs.
|
ChannelNotOpenedException |
This exception is thrown when action that need open channel occurs.
|
ChannelReceiverInitializationException |
This exception is thrown when channel receiver initialization problem occurs.
|
DisabledMethodException |
DisabledMethodException throws when disabled method execution occurs.
|
IllegalAttributeValueException |
The exception notifies about some problem in user request message.
It may mean absence of required attribute or its invalid value. |
MissingAttributeException |
This exception means that SDK don't recognize the attribute sent
by the server.
|
NoChannelEndpointException |
This exception is thrown when configure action for channel without assigned endpoint occurs.
|
ProtocolException | |
ProtocolIOException |
The ProtocolIOException will thrown if connection IO exception occurs.
|
ProtocolSecurityException |
The ProtocolSecurityException will thrown if any security problems occurs on a channel.
|
ProtocolTimeoutException |
The ProtocolHandshakeTimeoutException will thrown due timeout while a handshake.
|
RecursiveCallException |
Used to control caller thread and prevent some recursive calls.
|
RegistrationException |
Thrown when there are problems during client registration stage of
channel opening.
|
RegistrationTimeoutException |
The ProtocolHandshakeTimeoutException will thrown due timeout while a handshake.
|
RequestUnReferenceableException |
This exception is thrown when
ClientChannel.requestAsync(...) or
ClientChannel.beginRequest(...) is called with request message which is not
Referenceable . |
Annotation Type | Description |
---|---|
ProtocolDescription.Tag |
Indicates protocol and SDK name of protocol class.
|
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.