Platform SDK Java 8.5 API Reference

Uses of Interface
com.genesyslab.platform.commons.protocol.ClientChannel.ClientHandshakeStep

Packages that use ClientChannel.ClientHandshakeStep
com.genesyslab.platform.commons.protocol Contains classes that support the Protocol objects used by applications developed with the Platform SDKs. 
com.genesyslab.platform.webmedia.protocol This package contains the Protocol classes that allow you to create applications that integrate with Genesys non-voice media servers. 
 

Uses of ClientChannel.ClientHandshakeStep in com.genesyslab.platform.commons.protocol
 

Classes in com.genesyslab.platform.commons.protocol that implement ClientChannel.ClientHandshakeStep
protected  class ClientChannel.BasicClientHandshakeStep
          Abstract class with common or some default logic for client handshake steps.
 

Methods in com.genesyslab.platform.commons.protocol that return ClientChannel.ClientHandshakeStep
protected  ClientChannel.ClientHandshakeStep ClientChannel.BasicClientHandshakeStep.getNextStep()
          Creates and returns instance of the next handshake step.
protected  ClientChannel.ClientHandshakeStep ClientChannel.BasicClientHandshakeStep.gotoNextStep()
          Gets instance of the next step with virtual ClientChannel.BasicClientHandshakeStep.getNextStep().
 ClientChannel.ClientHandshakeStep ClientChannel.ClientHandshakeStep.handleMessage(Message event)
          This method handles incoming message assuming it is a server response for the request by initState().
It is responsible for the following operations: Check that the incoming message is a "successful" response to the request, extract store useful information like session id, server version, etc. If the message is an error message, it should throw appropriate exception. If the message is some acceptable unsolicited event, it may be passed through to user code. It returns null if handshake is successfully finished. It returns "self" reference to handle next incoming message with this state. It returns something like (new NextStep()).initState() to successfully pass this step and to switch to the next one.
 ClientChannel.ClientHandshakeStep ClientChannel.ClientHandshakeStep.initState()
          General goal of this method is to send the request message and get ready to handle server response with handleMessage(Message).
 ClientChannel.ClientHandshakeStep ClientChannel.BasicClientHandshakeStep.initState()
          Default implementation of this interface method is very simple.
It gets new instance of the request message, sends it and returns self reference to be called when server response arrived.
protected  ClientChannel.ClientHandshakeStep ClientChannel.BasicClientHandshakeStep.passEventDirectly(Message event)
          Its an utility method to be used from particular steps implementations in handleMessage(Message) to enqueue and later pass unsolicited protocol messages to user code after handshake finished and the channel set as "Opened".
protected  ClientChannel.ClientHandshakeStep ClientChannel.BasicClientHandshakeStep.passEventThrough(Message event)
          Its an utility method to be used from particular steps implementations in handleMessage(Message) to enqueue and later pass unsolicited protocol messages to user code after handshake finished and the channel set as "Opened".
 

Methods in com.genesyslab.platform.commons.protocol with parameters of type ClientChannel.ClientHandshakeStep
protected  void ClientChannel.setHandshakePhase(ClientChannel.ClientHandshakeStep handshakeStart)
          Initializes.
 

Uses of ClientChannel.ClientHandshakeStep in com.genesyslab.platform.webmedia.protocol
 

Methods in com.genesyslab.platform.webmedia.protocol that return ClientChannel.ClientHandshakeStep
protected abstract  ClientChannel.ClientHandshakeStep OptionalRegistrationChannel.getHandshakeStart()
          This virtual method returns initial handshake step for this channel.
protected  ClientChannel.ClientHandshakeStep FlexChatProtocol.getHandshakeStart()
           
protected  ClientChannel.ClientHandshakeStep BasicChatProtocol.getHandshakeStart()
           
 


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.