Configuration Platform SDK 7.6 API Reference

Package com.genesyslab.platform.commons.protocol

Contains classes that support the Protocol objects used by applications developed with the Platform SDKs.

See:
          Description

Interface Summary
AsyncChannel Communication channel.
AsyncInvokerSupport  
Channel Communication channel with synchronous opening and closing.
ChannelListener  
ChannelListenerSupport  
ConfigurationSupport  
ConnectionInvokerSupport  
EndpointSupport  
InputChannel  
InterceptorSupport  
Listener Marker interface for event listeners.
ListenerHelper.NotificationVisitor  
MessageCorrelator.MessageEntry  
MessageParser.ErrorHandler  
MessageReceiver  
MessageReceiverManagement  
MessageReceiverSupport  
OutputChannel  
Protocol Protocol is Input/Output Synchronous/Asynchronous channel.
ProtocolDescriptionSupport  
ProtocolFactory  
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.
 

Class Summary
AbstractChannel  
AbstractProtocolFactory  
AbstractQueueReceiver  
AbstractReferenceBuilder  
ChannelClosedEvent  
ChannelErrorEvent  
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.
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 and port.
EnumDescriptions  
IntReferenceBuilder  
ListenerHelper  
Message This abstract class provides the interface used for all Event classes.
MessageCorrelator  
MessageParser This class can be used for manual extracting Message object from byte array.
ProtocolDescription  
QueueMessageReceiver  
QueueRequestReceiver  
ServerChannel This channel accepts connection on some Endpoint.
XmlMessageSerializer  
 

Exception Summary
MissingAttributeException This exception means that SDK don't recognize the attribute sent by the server.
ProtocolException  
RegistrationException Thrown when there are problems during client registration stage of channel opening.
 

Package com.genesyslab.platform.commons.protocol Description

Contains classes that support the Protocol objects used by applications developed with the Platform SDKs.

It contains the Endpoint class, the Message abstract class, the ChannelState enum, and the ProtocolException exception.

The other elements in this package are for Genesys internal use only. Some of them may be documented to help you understand how the Platform SDKs work, but none of them should be explicitly invoked by your applications.

For general information on the structure and usage of the Platform SDKs, please refer to the Welcome page at the beginning of this guide.

For documentation of the Protocol objects you will need to use to write applications using the Platform SDK, please refer to the documentation in this guide for the Protocols package associated with the particular SDK you are interested in. For example, if you are using the Open Media Platform SDK, you would look at the documentation for com.genesyslab.platform.openmedia.protocol.


Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.