org.restcomm.media.network.deprecated.channel

Class AbstractNetworkChannel

java.lang.Object

org.restcomm.media.network.deprecated.channel.AbstractNetworkChannel

All Implemented Interfaces:

AutoCloseable, NetworkChannel

Direct Known Subclasses:

MultiplexedNetworkChannel

public abstract class AbstractNetworkChannel
extends Object
implements NetworkChannel

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected DatagramChannel	dataChannel
protected SelectionKey	selectionKey

Constructor Summary

Constructors

Constructor and Description
AbstractNetworkChannel(NetworkGuard guard)

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.
protected abstract org.apache.log4j.Logger	log()
protected abstract void	onIncomingPacket(byte[] data, InetSocketAddress remotePeer)
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.

Methods inherited from class java.lang.Object

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

Field Detail

selectionKey

protected SelectionKey selectionKey

dataChannel

protected DatagramChannel dataChannel

Constructor Detail

AbstractNetworkChannel

public AbstractNetworkChannel(NetworkGuard guard)

Method Detail

bind

public void bind(InetSocketAddress address)
          throws IOException

Description copied from interface: NetworkChannel

Binds the channel to an address.

Specified by:

bind in interface NetworkChannel

Parameters:

address - the address the channel will be bounds to

Throws:

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

open

public void open()
          throws IOException

Description copied from interface: NetworkChannel

Opens the channel.

Specified by:

open in interface NetworkChannel

Throws:

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

close

public void close()

Description copied from interface: NetworkChannel

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NetworkChannel

register

public void register(Selector selector,
            int opts)
              throws ClosedChannelException

Description copied from interface: NetworkChannel

Registers this channel into a selector for multiplexing purposes.

Specified by:

register in interface NetworkChannel

Parameters:

selector - The selector where the channel will be registered.

Throws:

ClosedChannelException - If the channel is closed

connect

public void connect(InetSocketAddress address)
             throws IOException

Description copied from interface: NetworkChannel

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

Specified by:

connect in interface NetworkChannel

Parameters:

address - The address of the remote peer to connect to

Throws:

IOException

disconnect

public void disconnect()
                throws IOException

Description copied from interface: NetworkChannel

Disconnect the channel

Specified by:

disconnect in interface NetworkChannel

Throws:

IOException

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: NetworkChannel

Gets the address the channel is bound to.

Specified by:

getLocalAddress in interface NetworkChannel

Returns:

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

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: NetworkChannel

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

Specified by:

getRemoteAddress in interface NetworkChannel

Returns:

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

isOpen

public boolean isOpen()

Description copied from interface: NetworkChannel

Gets whether channel is open or not.

Specified by:

isOpen in interface NetworkChannel

Returns:

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

isConnected

public boolean isConnected()

Description copied from interface: NetworkChannel

Gets whether channel is connected or not.

Specified by:

isConnected in interface NetworkChannel

Returns:

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

isRegistered

public boolean isRegistered()

Description copied from interface: NetworkChannel

Gets whether channel is registered in a Selector.

Specified by:

isRegistered in interface NetworkChannel

Returns:

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

receive

public void receive()
             throws IOException

Description copied from interface: NetworkChannel

Receives incoming data.

Specified by:

receive in interface NetworkChannel

Throws:

IOException

send

public void send(byte[] data)
          throws IOException

Description copied from interface: NetworkChannel

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

Specified by:

send in interface NetworkChannel

Parameters:

data - The data to be sent.

Throws:

IOException

send

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

Description copied from interface: NetworkChannel

Send data through the channel.

Specified by:

send in interface NetworkChannel

Parameters:

data - The data to be sent.

remotePeer - The address of the remote peer.

Throws:

IOException

send

public void send(ByteBuffer data,
        InetSocketAddress remotePeer)
          throws IOException

Description copied from interface: NetworkChannel

Send data through the channel.

Specified by:

send in interface NetworkChannel

Parameters:

data - The data to be sent.

remotePeer - The address of the remote peer.

Throws:

IOException

onIncomingPacket

protected abstract void onIncomingPacket(byte[] data,
                    InetSocketAddress remotePeer)

log

protected abstract org.apache.log4j.Logger log()