org.asteriskjava.util.internal

Class SocketConnectionFacadeImpl

java.lang.Object

org.asteriskjava.util.internal.SocketConnectionFacadeImpl

All Implemented Interfaces:

SocketConnectionFacade

public class SocketConnectionFacadeImpl
extends Object
implements SocketConnectionFacade

Default implementation of the SocketConnectionFacade interface using java.io.

Version:

$Id$

Author:

srt

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	CRNL_PATTERN
static int	MAX_SOCKET_READ_TIMEOUT_MILLIS 3 hrs = 3 * 3660 * 1000
static Pattern	NL_PATTERN

Constructor Summary

Constructors

Constructor and Description
SocketConnectionFacadeImpl(String host, int port, boolean ssl, int timeout, int readTimeout) <<<<<<< HEAD Creates a new instance for use with the Manager API that uses UTF-8 as encoding and CRNL ("\r\n") as line delimiter.
SocketConnectionFacadeImpl(String host, int port, boolean ssl, int timeout, int readTimeout, Charset encoding) Creates a new instance for use with the Manager API that uses the given encoding and CRNL ("\r\n") as line delimiter.
SocketConnectionFacadeImpl(String host, int port, boolean ssl, int timeout, int readTimeout, Charset encoding, Pattern lineDelimiter) Creates a new instance for use with the Manager API that uses the given encoding and line delimiter.
SocketConnectionFacadeImpl(String host, int port, boolean ssl, int timeout, int readTimeout, Pattern lineDelimiter) Creates a new instance for use with the Manager API that uses UTF-8 as encoding and the given line delimiter.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the socket connection including its input and output stream and frees all associated ressources.
void	flush() Flushes the socket connection by sending any buffered but yet unsent data.
InetAddress	getLocalAddress() Returns the local address this socket connection.
int	getLocalPort() Returns the local port of this socket connection.
InetAddress	getRemoteAddress() Returns the remote address of this socket connection.
int	getRemotePort() Returns the remote port of this socket connection.
boolean	isConnected() Returns the connection state of the socket.
String	readLine() Reads a line of text from the socket connection.
void	write(String s) Sends a given String to the socket connection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CRNL_PATTERN

public static final Pattern CRNL_PATTERN

NL_PATTERN

public static final Pattern NL_PATTERN

MAX_SOCKET_READ_TIMEOUT_MILLIS

public static final int MAX_SOCKET_READ_TIMEOUT_MILLIS

3 hrs = 3 * 3660 * 1000

See Also:

Constant Field Values

Constructor Detail

SocketConnectionFacadeImpl

public SocketConnectionFacadeImpl(String host,
                                  int port,
                                  boolean ssl,
                                  int timeout,
                                  int readTimeout)
                           throws IOException

<<<<<<< HEAD Creates a new instance for use with the Manager API that uses UTF-8 as encoding and CRNL ("\r\n") as line delimiter. ======= Creates a new instance for use with the Manager API that uses CRNL ("\r\n") as line delimiter. >>>>>>> refs/heads/release-1.1

Parameters:

host - the foreign host to connect to.

port - the foreign port to connect to.

ssl - true to use SSL, false otherwise.

timeout - 0 incidcates default

readTimeout - see Socket.setSoTimeout(int)

Throws:

IOException - if the connection cannot be established.

SocketConnectionFacadeImpl

public SocketConnectionFacadeImpl(String host,
                                  int port,
                                  boolean ssl,
                                  int timeout,
                                  int readTimeout,
                                  Charset encoding)
                           throws IOException

Creates a new instance for use with the Manager API that uses the given encoding and CRNL ("\r\n") as line delimiter.

Parameters:

host - the foreign host to connect to.

port - the foreign port to connect to.

ssl - true to use SSL, false otherwise.

timeout - 0 incidcates default

readTimeout - see Socket.setSoTimeout(int)

encoding - the encoding used for transmission of strings (all connections should use the same encoding)

Throws:

IOException - if the connection cannot be established.

SocketConnectionFacadeImpl

public SocketConnectionFacadeImpl(String host,
                                  int port,
                                  boolean ssl,
                                  int timeout,
                                  int readTimeout,
                                  Pattern lineDelimiter)
                           throws IOException

Creates a new instance for use with the Manager API that uses UTF-8 as encoding and the given line delimiter.

Parameters:

host - the foreign host to connect to.

port - the foreign port to connect to.

ssl - true to use SSL, false otherwise.

timeout - 0 incidcates default

readTimeout - see Socket.setSoTimeout(int)

lineDelimiter - a Pattern for matching the line delimiter for the socket

Throws:

IOException - if the connection cannot be established.

SocketConnectionFacadeImpl

public SocketConnectionFacadeImpl(String host,
                                  int port,
                                  boolean ssl,
                                  int timeout,
                                  int readTimeout,
                                  Charset encoding,
                                  Pattern lineDelimiter)
                           throws IOException

Creates a new instance for use with the Manager API that uses the given encoding and line delimiter.

Parameters:

host - the foreign host to connect to.

port - the foreign port to connect to.

ssl - true to use SSL, false otherwise.

timeout - 0 incidcates default

readTimeout - see Socket.setSoTimeout(int)

encoding - the encoding used for transmission of strings (all connections should use the same encoding)

lineDelimiter - a Pattern for matching the line delimiter for the socket

Throws:

IOException - if the connection cannot be established.

Method Detail

readLine

public String readLine()
                throws IOException

Description copied from interface: SocketConnectionFacade

Reads a line of text from the socket connection. The current thread is blocked until either the next line is received or an IOException encounters.

Depending on the implementation different newline delimiters are used ("\r\n" for the Manager API and "\n" for AGI).

Specified by:

readLine in interface SocketConnectionFacade

Returns:

the line of text received excluding the newline delimiter.

Throws:

IOException - if the connection has been closed.

write

public void write(String s)
           throws IOException

Description copied from interface: SocketConnectionFacade

Sends a given String to the socket connection.

Specified by:

write in interface SocketConnectionFacade

Parameters:

s - the String to send.

Throws:

IOException - if the String cannot be sent, maybe because the connection has already been closed.

flush

public void flush()
           throws IOException

Description copied from interface: SocketConnectionFacade

Flushes the socket connection by sending any buffered but yet unsent data.

Specified by:

flush in interface SocketConnectionFacade

Throws:

IOException - if the connection cannot be flushed.

close

public void close()
           throws IOException

Description copied from interface: SocketConnectionFacade

Closes the socket connection including its input and output stream and frees all associated ressources.

When calling close() any Thread currently blocked by a call to readLine() will be unblocked and receive an IOException.

Specified by:

close in interface SocketConnectionFacade

Throws:

IOException - if the socket connection cannot be closed.

isConnected

public boolean isConnected()

Description copied from interface: SocketConnectionFacade

Returns the connection state of the socket.

Specified by:

isConnected in interface SocketConnectionFacade

Returns:

true if the socket successfuly connected to a server

getLocalAddress

public InetAddress getLocalAddress()

Description copied from interface: SocketConnectionFacade

Returns the local address this socket connection.

Specified by:

getLocalAddress in interface SocketConnectionFacade

Returns:

the local address this socket connection.

getLocalPort

public int getLocalPort()

Description copied from interface: SocketConnectionFacade

Returns the local port of this socket connection.

Specified by:

getLocalPort in interface SocketConnectionFacade

Returns:

the local port of this socket connection.

getRemoteAddress

public InetAddress getRemoteAddress()

Description copied from interface: SocketConnectionFacade

Returns the remote address of this socket connection.

Specified by:

getRemoteAddress in interface SocketConnectionFacade

Returns:

the remote address of this socket connection.

getRemotePort

public int getRemotePort()

Description copied from interface: SocketConnectionFacade

Returns the remote port of this socket connection.

Specified by:

getRemotePort in interface SocketConnectionFacade

Returns:

the remote port of this socket connection.