SocketConnectionFacade (Asterisk-Java 2.0.2 API)

All Known Implementing Classes:

SocketConnectionFacadeImpl
```
public interface SocketConnectionFacade
```
The SocketConnectionFacade provides read and write operation for communication over TCP/IP sockets.
It hides the details of the underlying I/O system used for socket communication.

Version:

$Id$

Author:

srt

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - readLine
```
String readLine()
         throws IOException
```
    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).
    
    Returns:
    
    the line of text received excluding the newline delimiter.
    
    Throws:
    
    IOException - if the connection has been closed.
  - write
```
void write(String s)
    throws IOException
```
    Sends a given String to the socket connection.
    
    Parameters:
    
    s - the String to send.
    
    Throws:
    
    IOException - if the String cannot be sent, maybe because the connection has already been closed.
  - flush
```
void flush()
    throws IOException
```
    Flushes the socket connection by sending any buffered but yet unsent data.
    
    Throws:
    
    IOException - if the connection cannot be flushed.
  - close
```
void close()
    throws IOException
```
    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.
    
    Throws:
    
    IOException - if the socket connection cannot be closed.
  - isConnected
```
boolean isConnected()
```
    Returns the connection state of the socket.
    
    Returns:
    
    true if the socket successfuly connected to a server
  - getLocalAddress
```
InetAddress getLocalAddress()
```
    Returns the local address this socket connection.
    
    Returns:
    
    the local address this socket connection.
    
    Since:
    
    0.2
  - getLocalPort
```
int getLocalPort()
```
    Returns the local port of this socket connection.
    
    Returns:
    
    the local port of this socket connection.
    
    Since:
    
    0.2
  - getRemoteAddress
```
InetAddress getRemoteAddress()
```
    Returns the remote address of this socket connection.
    
    Returns:
    
    the remote address of this socket connection.
    
    Since:
    
    0.2
  - getRemotePort
```
int getRemotePort()
```
    Returns the remote port of this socket connection.
    
    Returns:
    
    the remote port of this socket connection.
    
    Since:
    
    0.2

Interface SocketConnectionFacade

Method Summary

Method Detail

readLine

write

flush

close

isConnected

getLocalAddress

getLocalPort

getRemoteAddress

getRemotePort