org.asteriskjava.manager.internal

Interface ManagerReader

All Superinterfaces:

Runnable

All Known Implementing Classes:

ManagerReaderImpl

public interface ManagerReader
extends Runnable

The ManagerReader reads events and responses from the asterisk server, parses them using EventBuilderImpl and ResponseBuilder and dispatches them to the associated ManagerConnection.

Do not use this interface in your code, it is intended to be used only by the DefaultManagerConnection.

Version:

$Id$

Author:

srt

See Also:

EventBuilder, ResponseBuilder, DefaultManagerConnection

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_RESULT_RESPONSE_KEY

Method Summary

Modifier and Type	Method and Description
void	deregisterEventClass(Class<? extends ManagerEvent> eventClass)
void	die() Terminates this reader.
void	expectResponseClass(String internalActionId, Class<? extends ManagerResponse> responseClass)
IOException	getTerminationException() Returns the Exception that caused this reader to terminate if any.
boolean	isDead() Checks whether this reader is terminating or terminated.
void	registerEventClass(Class<? extends ManagerEvent> event) Registers a new event type with the underlying EventBuilderImpl.
void	setSocket(SocketConnectionFacade socket) Sets the socket to use for reading from the asterisk server.

Methods inherited from interface java.lang.Runnable

run

Field Detail

COMMAND_RESULT_RESPONSE_KEY

static final String COMMAND_RESULT_RESPONSE_KEY

See Also:

Constant Field Values

Method Detail

setSocket

void setSocket(SocketConnectionFacade socket)

Sets the socket to use for reading from the asterisk server.

Parameters:

socket - the socket to use for reading from the asterisk server.

registerEventClass

void registerEventClass(Class<? extends ManagerEvent> event)

Registers a new event type with the underlying EventBuilderImpl.

The eventClass must extend ManagerEvent.

Parameters:

event - class of the event to register.

See Also:

EventBuilder, ManagerEvent

expectResponseClass

void expectResponseClass(String internalActionId,
                         Class<? extends ManagerResponse> responseClass)

die

void die()

Terminates this reader.

isDead

boolean isDead()

Checks whether this reader is terminating or terminated.

Returns:

true if this reader is terminating or terminated, false otherwise.

getTerminationException

IOException getTerminationException()

Returns the Exception that caused this reader to terminate if any.

Returns:

the Exception that caused this reader to terminate if any or null if not.

deregisterEventClass

void deregisterEventClass(Class<? extends ManagerEvent> eventClass)