A B C D E F G H I J L M O R S T U V

A

AbstractEslClientHandler - Class in org.freeswitch.esl.client.internal

Specialised ChannelUpstreamHandler that implements the logic of an ESL connection that is common to both inbound and outbound clients.

AbstractEslClientHandler() - Constructor for class org.freeswitch.esl.client.internal.AbstractEslClientHandler

AbstractOutboundClientHandler - Class in org.freeswitch.esl.client.outbound

Specialised AbstractEslClientHandler that implements the base connecction logic for an 'Outbound' FreeSWITCH Event Socket connection.

AbstractOutboundClientHandler() - Constructor for class org.freeswitch.esl.client.outbound.AbstractOutboundClientHandler

AbstractOutboundPipelineFactory - Class in org.freeswitch.esl.client.outbound

An abstract factory to assemble a Netty processing pipeline for outbound clients.

AbstractOutboundPipelineFactory() - Constructor for class org.freeswitch.esl.client.outbound.AbstractOutboundPipelineFactory

addCallCommand(String) - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

addEventFilter(String, String) - Method in class org.freeswitch.esl.client.inbound.Client

Add an event filter to the current set of event filters on this connection.

addEventListener(IEslEventListener) - Method in class org.freeswitch.esl.client.inbound.Client

addEventLock() - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

addExecuteAppArg(String) - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

addExecuteAppName(String) - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

addGenericLine(String, String) - Method in class org.freeswitch.esl.client.transport.SendMsg

A generic method to add a message line.

addHangupCause(String) - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

addLoops(int) - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

addNomediaUuid(String) - Method in class org.freeswitch.esl.client.transport.SendMsg

Adds the following line to the message:

API_RESPONSE - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"api/response"

AUTH_REQUEST - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"auth/request"

authResponseReceived(CommandResponse) - Method in interface org.freeswitch.esl.client.internal.IEslProtocolListener

B

backgroundJobResultReceived(EslEvent) - Method in interface org.freeswitch.esl.client.IEslEventListener

Signal of an event containing the result of a client requested background job.

C

cancelEventSubscriptions() - Method in class org.freeswitch.esl.client.inbound.Client

Cancel any existing event subscription.

cancelLogging() - Method in class org.freeswitch.esl.client.inbound.Client

Disable any logging previously enabled with setLogLevel().

canSend() - Method in class org.freeswitch.esl.client.inbound.Client

channelConnected(ChannelHandlerContext, ChannelStateEvent) - Method in class org.freeswitch.esl.client.outbound.AbstractOutboundClientHandler

ChannelEventRunnable - Class in org.freeswitch.esl.client.internal.debug

a Runnable which sends the specified ChannelEvent upstream.

ChannelEventRunnable(ChannelHandlerContext, ChannelEvent) - Constructor for class org.freeswitch.esl.client.internal.debug.ChannelEventRunnable

Creates a Runnable which sends the specified ChannelEvent upstream via the specified ChannelHandlerContext.

Client - Class in org.freeswitch.esl.client.inbound

Entry point to connect to a running FreeSWITCH Event Socket Library module, as a client.

Client() - Constructor for class org.freeswitch.esl.client.inbound.Client

close() - Method in class org.freeswitch.esl.client.inbound.Client

Close the socket connection

COMMAND_REPLY - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"command/reply"

CommandResponse - Class in org.freeswitch.esl.client.transport

Result object to carry the results of a command sent to the FreeSWITCH Event Socket.

CommandResponse(String, EslMessage) - Constructor for class org.freeswitch.esl.client.transport.CommandResponse

connect(String, int, String, int) - Method in class org.freeswitch.esl.client.inbound.Client

Attempt to establish an authenticated connection to the nominated FreeSWITCH ESL server socket.

CONTENT_LENGTH - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Content-Length"

CORE_UUID - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Core-UUID"

D

deleteEventFilter(String, String) - Method in class org.freeswitch.esl.client.inbound.Client

Delete an event filter from the current set of event filters on this connection.

disconnected() - Method in interface org.freeswitch.esl.client.internal.IEslProtocolListener

E

ERR_INVALID - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"-ERR invalid"

EslEvent - Class in org.freeswitch.esl.client.transport.event

FreeSWITCH Event Socket events are decoded into this data object.

EslEvent(EslMessage) - Constructor for class org.freeswitch.esl.client.transport.event.EslEvent

EslEvent(EslMessage, boolean) - Constructor for class org.freeswitch.esl.client.transport.event.EslEvent

EslEventHeaderNames - Class in org.freeswitch.esl.client.transport.event

Convenience container class for some commonly used ESL event header names (note there are many more!).

EslFrameDecoder - Class in org.freeswitch.esl.client.transport.message

Decoder used by the IO processing pipeline.

EslFrameDecoder(int) - Constructor for class org.freeswitch.esl.client.transport.message.EslFrameDecoder

EslFrameDecoder(int, boolean) - Constructor for class org.freeswitch.esl.client.transport.message.EslFrameDecoder

EslHeaders - Class in org.freeswitch.esl.client.transport.message

Container class for enumeration of ESL message header names, and some commonly used header string values.

EslHeaders() - Constructor for class org.freeswitch.esl.client.transport.message.EslHeaders

EslHeaders.Name - Enum in org.freeswitch.esl.client.transport.message

Standard ESL header names.

EslHeaders.Value - Class in org.freeswitch.esl.client.transport.message

Some common ESL header values.

EslHeaders.Value() - Constructor for class org.freeswitch.esl.client.transport.message.EslHeaders.Value

EslMessage - Class in org.freeswitch.esl.client.transport.message

Basic FreeSWITCH Event Socket messages from the server are decoded into this data object.

EslMessage() - Constructor for class org.freeswitch.esl.client.transport.message.EslMessage

EVENT_CALLING_FILE - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Calling-File"

EVENT_CALLING_FUNCTION - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Calling-Function"

EVENT_CALLING_LINE_NUMBER - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Calling-Line-Number"

EVENT_DATE_GMT - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Date-GMT"

EVENT_DATE_LOCAL - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Date-Local"

EVENT_DATE_TIMESTAMP - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Date-Timestamp"

EVENT_NAME - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Event-Name"

eventReceived(EslEvent) - Method in interface org.freeswitch.esl.client.IEslEventListener

Signal of a server initiated event.

eventReceived(EslEvent) - Method in interface org.freeswitch.esl.client.internal.IEslProtocolListener

ExecutionHandler - Class in org.freeswitch.esl.client.internal.debug

Forwards an upstream ChannelEvent to an Executor.

ExecutionHandler(Executor) - Constructor for class org.freeswitch.esl.client.internal.debug.ExecutionHandler

Creates a new instance with the specified Executor.

F

FREESWITCH_HOSTNAME - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"FreeSWITCH-Hostname"

FREESWITCH_IPV4 - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"FreeSWITCH-IPv4"

FREESWITCH_IPV6 - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"FreeSWITCH-IPv6"

fromLiteral(String) - Static method in enum org.freeswitch.esl.client.transport.message.EslHeaders.Name

G

getBodyLines() - Method in class org.freeswitch.esl.client.transport.message.EslMessage

Any received message body lines

getCommand() - Method in class org.freeswitch.esl.client.transport.CommandResponse

getContentLength() - Method in class org.freeswitch.esl.client.transport.message.EslMessage

Convenience method

getContentType() - Method in class org.freeswitch.esl.client.transport.message.EslMessage

Convenience method

getContext() - Method in class org.freeswitch.esl.client.internal.debug.ChannelEventRunnable

Returns the ChannelHandlerContext which will be used to send the ChannelEvent upstream.

getEvent() - Method in class org.freeswitch.esl.client.internal.debug.ChannelEventRunnable

Returns the ChannelEvent which will be sent upstream.

getEventBodyLines() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

Any event body lines that were present in the event.

getEventDateGmt() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

Convenience method.

getEventDateLocal() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

Convenience method.

getEventDateTimestamp() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

Convenience method.

getEventHeaders() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

The event headers of this event.

getEventName() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

Convenience method.

getExecutor() - Method in class org.freeswitch.esl.client.internal.debug.ExecutionHandler

Returns the Executor which was specified with the constructor.

getHeaders() - Method in class org.freeswitch.esl.client.transport.message.EslMessage

All the received message headers in a map keyed by EslHeaders.Name.

getHeaderValue(EslHeaders.Name) - Method in class org.freeswitch.esl.client.transport.message.EslMessage

Convenience method

getMessageHeaders() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

The message headers of the original ESL message from which this event was decoded.

getMsgLines() - Method in class org.freeswitch.esl.client.transport.SendMsg

The list of strings that make up the message to send to FreeSWITCH.

getPipeline() - Method in class org.freeswitch.esl.client.inbound.InboundPipelineFactory

getPipeline() - Method in class org.freeswitch.esl.client.outbound.AbstractOutboundPipelineFactory

getReplyText() - Method in class org.freeswitch.esl.client.transport.CommandResponse

getResponse() - Method in class org.freeswitch.esl.client.transport.CommandResponse

H

handleDownstream(ChannelHandlerContext, ChannelEvent) - Method in class org.freeswitch.esl.client.internal.debug.ExecutionHandler

handleUpstream(ChannelHandlerContext, ChannelEvent) - Method in class org.freeswitch.esl.client.internal.debug.ExecutionHandler

hasContentLength() - Method in class org.freeswitch.esl.client.transport.message.EslMessage

Convenience method

hasEventBody() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

Convenience method.

hasHeader(EslHeaders.Name) - Method in class org.freeswitch.esl.client.transport.message.EslMessage

Convenience method

hasUuid() - Method in class org.freeswitch.esl.client.transport.SendMsg

Indicate if message was constructed with a UUID.

HeaderParser - Class in org.freeswitch.esl.client.internal

This parser provides a static helper method to split a standard Header field into the name and value parts.

HeaderParser() - Constructor for class org.freeswitch.esl.client.internal.HeaderParser

I

IEslEventListener - Interface in org.freeswitch.esl.client

Interface for observers wanting to be notified of incoming FreeSWITCH Event Socket events.

IEslProtocolListener - Interface in org.freeswitch.esl.client.internal

End users of the Client should not need to use this class.

InboundClientHandler - Class in org.freeswitch.esl.client.inbound

End users of the inbound Client should not need to use this class.

InboundClientHandler(String, IEslProtocolListener) - Constructor for class org.freeswitch.esl.client.inbound.InboundClientHandler

InboundConnectionFailure - Exception in org.freeswitch.esl.client.inbound

Checked exception to handle connection failures.

InboundConnectionFailure(String) - Constructor for exception org.freeswitch.esl.client.inbound.InboundConnectionFailure

InboundConnectionFailure(String, Throwable) - Constructor for exception org.freeswitch.esl.client.inbound.InboundConnectionFailure

InboundPipelineFactory - Class in org.freeswitch.esl.client.inbound

End users of the Client should not need to use this class.

InboundPipelineFactory(ChannelHandler) - Constructor for class org.freeswitch.esl.client.inbound.InboundPipelineFactory

isOk() - Method in class org.freeswitch.esl.client.transport.CommandResponse

J

JOB_COMMAND - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Job-Command"

JOB_UUID - Static variable in class org.freeswitch.esl.client.transport.event.EslEventHeaderNames

"Job-UUID"

L

LINE_TERMINATOR - Static variable in class org.freeswitch.esl.client.internal.AbstractEslClientHandler

literal() - Method in enum org.freeswitch.esl.client.transport.message.EslHeaders.Name

M

MESSAGE_TERMINATOR - Static variable in class org.freeswitch.esl.client.internal.AbstractEslClientHandler

messageReceived(ChannelHandlerContext, MessageEvent) - Method in class org.freeswitch.esl.client.internal.AbstractEslClientHandler

O

OK - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"+OK"

org.freeswitch.esl.client - package org.freeswitch.esl.client

org.freeswitch.esl.client.inbound - package org.freeswitch.esl.client.inbound

org.freeswitch.esl.client.internal - package org.freeswitch.esl.client.internal

org.freeswitch.esl.client.internal.debug - package org.freeswitch.esl.client.internal.debug

org.freeswitch.esl.client.outbound - package org.freeswitch.esl.client.outbound

org.freeswitch.esl.client.outbound.example - package org.freeswitch.esl.client.outbound.example

org.freeswitch.esl.client.transport - package org.freeswitch.esl.client.transport

org.freeswitch.esl.client.transport.event - package org.freeswitch.esl.client.transport.event

org.freeswitch.esl.client.transport.message - package org.freeswitch.esl.client.transport.message

R

releaseExternalResources() - Method in class org.freeswitch.esl.client.internal.debug.ExecutionHandler

Shuts down the Executor which was specified with the constructor and wait for its termination.

run() - Method in class org.freeswitch.esl.client.internal.debug.ChannelEventRunnable

Sends the event upstream.

S

sendAsyncApiCommand(String, String) - Method in class org.freeswitch.esl.client.inbound.Client

Submit a FreeSWITCH API command to the server to be executed in background mode.

sendAsyncCommand(Channel, String) - Method in class org.freeswitch.esl.client.internal.AbstractEslClientHandler

Returns the Job UUID of that the response event will have.

sendMessage(SendMsg) - Method in class org.freeswitch.esl.client.inbound.Client

Send a SendMsg command to FreeSWITCH.

SendMsg - Class in org.freeswitch.esl.client.transport

SendMsg() - Constructor for class org.freeswitch.esl.client.transport.SendMsg

Constructor for use with outbound socket client only.

SendMsg(String) - Constructor for class org.freeswitch.esl.client.transport.SendMsg

Constructor for use with the inbound client.

sendSyncApiCommand(String, String) - Method in class org.freeswitch.esl.client.inbound.Client

Sends a FreeSWITCH API command to the server and blocks, waiting for an immediate response from the server.

sendSyncMultiLineCommand(Channel, List<String>) - Method in class org.freeswitch.esl.client.internal.AbstractEslClientHandler

Synthesise a synchronous command/response by creating a callback object which is placed in queue and blocks waiting for another IO thread to process an incoming EslMessage and attach it to the callback.

sendSyncSingleLineCommand(Channel, String) - Method in class org.freeswitch.esl.client.internal.AbstractEslClientHandler

Synthesise a synchronous command/response by creating a callback object which is placed in queue and blocks waiting for another IO thread to process an incoming EslMessage and attach it to the callback.

setEventSubscriptions(String, String) - Method in class org.freeswitch.esl.client.inbound.Client

Set the current event subscription for this connection to the server.

setLoggingLevel(String) - Method in class org.freeswitch.esl.client.inbound.Client

Enable log output.

SimpleHangupOutboundHandler - Class in org.freeswitch.esl.client.outbound.example

Simple example of a handler for outbound connection from FreeSWITCH server.

SimpleHangupOutboundHandler() - Constructor for class org.freeswitch.esl.client.outbound.example.SimpleHangupOutboundHandler

SimpleHangupPipelineFactory - Class in org.freeswitch.esl.client.outbound.example

Factory for the simple hangup handler

SimpleHangupPipelineFactory() - Constructor for class org.freeswitch.esl.client.outbound.example.SimpleHangupPipelineFactory

SocketClient - Class in org.freeswitch.esl.client.outbound

Entry point to run a socket client that a running FreeSWITCH Event Socket Library module can make outbound connections to.

SocketClient(int, AbstractOutboundPipelineFactory) - Constructor for class org.freeswitch.esl.client.outbound.SocketClient

splitHeader(String) - Static method in class org.freeswitch.esl.client.internal.HeaderParser

Split a header in the form

start() - Method in class org.freeswitch.esl.client.outbound.SocketClient

stop() - Method in class org.freeswitch.esl.client.outbound.SocketClient

T

TEXT_DISCONNECT_NOTICE - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"text/disconnect-notice"

TEXT_EVENT_PLAIN - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"text/event-plain"

TEXT_EVENT_XML - Static variable in class org.freeswitch.esl.client.transport.message.EslHeaders.Value

"text/event-xml"

toString() - Method in class org.freeswitch.esl.client.transport.event.EslEvent

toString() - Method in class org.freeswitch.esl.client.transport.message.EslMessage

toString() - Method in class org.freeswitch.esl.client.transport.SendMsg

U

unwrap() - Method in class org.freeswitch.esl.client.internal.debug.ChannelEventRunnable

V

valueOf(String) - Static method in enum org.freeswitch.esl.client.transport.message.EslHeaders.Name

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.freeswitch.esl.client.transport.message.EslHeaders.Name

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I J L M O R S T U V