AsyncChannel
, ChannelListenerSupport
ClusterProtocol
, InputChannel
, OutputChannel
, Protocol
, RequestChannel
, ResponseChannel
AbstractChannel
, AbstractClusterChannel
, BasicChatProtocol
, CallbackClientChannelHandler
, CallbackProtocol
, CallbackProtocolListener
, ChatClientChannelHandler
, ChatProtocolsListener
, ClientChannel
, ClientChannelHandler
, ClusterProtocolImpl
, ConfServerClientChannelHandler
, ConfServerProtocol
, ConfServerProtocolListener
, DuplexChannel
, EmailClientChannelHandler
, EmailProtocol
, EmailProtocolListener
, EspClusterProtocol
, EspEmailClientChannelHandler
, EspEmailClusterProtocol
, EspEmailProtocol
, EspEmailProtocolListener
, ExternalServiceClientChannelHandler
, ExternalServiceProtocol
, ExternalServiceProtocolListener
, FlexChatClusterProtocol
, FlexChatProtocol
, InteractionServerClientChannelHandler
, InteractionServerProtocol
, InteractionServerProtocolListener
, LcaUdpHeartbeatInternalProtocol
, LocalControlAgentProtocol
, MessageServerProtocol
, OptionalRegistrationChannel
, OutboundServerProtocol
, RoutingServerProtocol
, ServerChannel
, SolutionControlServerProtocol
, StatServerProtocol
, TServerProtocol
, UcsClusterProtocol
, UniversalContactServerClientChannelHandler
, UniversalContactServerProtocol
, UniversalContactServerProtocolListener
, UrsCustomProtocol
, UrsCustomProtocolListener
, WebmediaChannel
, WebMediaClientChannelHandler
public interface Channel extends AsyncChannel
Timeout can be set to following values:
Modifier and Type | Field | Description |
---|---|---|
static long |
DEFAULT_TIMEOUT |
|
static long |
INFINITE_TIMEOUT |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes channel synchronously.
|
void |
close(long timeout) |
Closes channel synchronously with given timeout.
|
long |
getTimeout() |
Returns default timeout for synchronous operations on channel.
|
void |
open() |
Opens the channel by opening underlying connection
including protocol specific handshake procedure.
This method will block until connection is opened or detects an error condition, possibly forever. |
void |
open(long timeout) |
Opens the channel by opening underlying connection
including protocol specific handshake procedure using
specified protocol timeout value.
Timeout can be set to following values: positive value - time in ms. |
void |
setTimeout(long timeout) |
Sets default timeout for synchronous operations on channel.
|
beginClose, beginOpen, getState
addChannelListener, removeChannelListener
static final long INFINITE_TIMEOUT
static final long DEFAULT_TIMEOUT
void open() throws RegistrationException, ProtocolException, java.lang.IllegalStateException, java.lang.InterruptedException
open(long)
method to use custom timeout
or change the protocol timeout value with setTimeout(long)
before opening.RegistrationException
- if there is an error related to registration procedure
like server error about wrong client name, user password, etcProtocolException
- if there is any problem related to the connection openjava.lang.IllegalStateException
- if channel is not in Closed
state.
Actually, in current Platform SDK implementation, the ChannelNotClosedException
which is subclass of IllegalStateException
can be thrown.java.lang.InterruptedException
setTimeout(long)
,
open(long)
void close() throws ProtocolException, java.lang.IllegalStateException, java.lang.InterruptedException
java.lang.InterruptedException
- in case the close operation was interrupted.ProtocolException
- if there is any problem related to the connection closejava.lang.IllegalStateException
- exception will not be thrown in current implementation.void open(long timeout) throws RegistrationException, ProtocolException, java.lang.IllegalStateException, java.lang.InterruptedException
timeout
- time to waitResponse for the connectionRegistrationException
- if there is an error related to registration procedure
like server error about wrong client name, user password, etcProtocolException
- if there is any problem related to the connection openjava.lang.IllegalStateException
- if channel is not in Closed
statejava.lang.InterruptedException
open()
void close(long timeout) throws ProtocolException, java.lang.IllegalStateException, java.lang.InterruptedException
java.lang.InterruptedException
- in case the close operation was interrupted.ProtocolException
- if there is any problem related to the connection closejava.lang.IllegalStateException
- exception will not be thrown in current implementation.void setTimeout(long timeout)
timeout
- timeout in millisecondslong getTimeout()
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.