org.restcomm.media.network.deprecated.channel

Interface NetworkChannel

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractNetworkChannel, MultiplexedNetworkChannel

public interface NetworkChannel
extends AutoCloseable

Represents a channel where data can be exchanged through the network.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	bind(InetSocketAddress address) Binds the channel to an address.
void	close() Disconnects and closes the channel. Invoking this method will have no effect if the channel is already closed.
void	connect(InetSocketAddress address) Connects the channel to a remote peer. The channel will only be able to accept traffic from that peer.
void	disconnect() Disconnect the channel
InetSocketAddress	getLocalAddress() Gets the address the channel is bound to.
InetSocketAddress	getRemoteAddress() Gets the address of the remote peer this channel is connected to.
boolean	isConnected() Gets whether channel is connected or not.
boolean	isOpen() Gets whether channel is open or not.
boolean	isRegistered() Gets whether channel is registered in a Selector.
void	open() Opens the channel.
void	receive() Receives incoming data.
void	register(Selector selector, int opts) Registers this channel into a selector for multiplexing purposes.
void	send(byte[] data) Sends data to the remote peer.
void	send(byte[] data, InetSocketAddress remotePeer) Send data through the channel.
void	send(ByteBuffer data, InetSocketAddress remotePeer) Send data through the channel.

Method Detail

bind

void bind(InetSocketAddress address)
          throws IOException

Binds the channel to an address.

Parameters:

address - the address the channel will be bounds to

Throws:

IOException - In case the channel is closed or could not be bound.

open

void open()
          throws IOException

Opens the channel.

Throws:

IOException - If the channel is already open or if it could not be opened.

close

void close()

Disconnects and closes the channel.
Invoking this method will have no effect if the channel is already closed.

Specified by:

close in interface AutoCloseable

register

void register(Selector selector,
            int opts)
              throws ClosedChannelException

Registers this channel into a selector for multiplexing purposes.

Parameters:

selector - The selector where the channel will be registered.

The - channel valid operation keys.

Throws:

ClosedChannelException - If the channel is closed

connect

void connect(InetSocketAddress address)
             throws IOException

Connects the channel to a remote peer.
The channel will only be able to accept traffic from that peer.

Parameters:

address - The address of the remote peer to connect to

Throws:

IOException

disconnect

void disconnect()
                throws IOException

Disconnect the channel

Throws:

IOException

getLocalAddress

InetSocketAddress getLocalAddress()

Gets the address the channel is bound to.

Returns:

Returns the local address of the channel. Returns null if the channel is not currently bound.

getRemoteAddress

InetSocketAddress getRemoteAddress()

Gets the address of the remote peer this channel is connected to.

Returns:

Returns the address of the remote peer. Returns null if the channel is not connected.

receive

void receive()
             throws IOException

Receives incoming data.

Throws:

IOException

send

void send(byte[] data)
          throws IOException

Sends data to the remote peer. Only usable if channel is connected.

Parameters:

data - The data to be sent.

Throws:

IOException

send

void send(byte[] data,
        InetSocketAddress remotePeer)
          throws IOException

Send data through the channel.

Parameters:

data - The data to be sent.

remotePeer - The address of the remote peer.

Throws:

IOException

send

void send(ByteBuffer data,
        InetSocketAddress remotePeer)
          throws IOException

Send data through the channel.

Parameters:

data - The data to be sent.

remotePeer - The address of the remote peer.

Throws:

IOException

isConnected

boolean isConnected()

Gets whether channel is connected or not.

Returns:

true if the channel is connected. Otherwise, returns false.

isOpen

boolean isOpen()

Gets whether channel is open or not.

Returns:

true if the channel is open. Otherwise, returns false.

isRegistered

boolean isRegistered()

Gets whether channel is registered in a Selector.

Returns:

true if the channel is registered. Otherwise, returns false.