net.named_data.jndn.transport

Class TcpTransport

java.lang.Object

net.named_data.jndn.transport.Transport

net.named_data.jndn.transport.TcpTransport

public class TcpTransport
extends Transport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpTransport.ConnectionInfo A TcpTransport.ConnectionInfo extends Transport.ConnectionInfo to hold the host and port info for the TCP connection.

Constructor Summary

Constructors

Constructor and Description
TcpTransport()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the connection.
void	connect(Transport.ConnectionInfo connectionInfo, ElementListener elementListener, Runnable onConnected) Connect according to the info in ConnectionInfo, and use elementListener.
boolean	getIsConnected() Check if the transport is connected.
static boolean	getIsLocal(String host) A static method to determine whether the host is on the current machine.
boolean	isAsync() Override to return false since connect does not need to use the onConnected callback.
boolean	isLocal(Transport.ConnectionInfo connectionInfo) Determine whether this transport connecting according to connectionInfo is to a node on the current machine; results are cached.
void	processEvents() Process any data to receive.
void	send(ByteBuffer data) Send data to the host

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpTransport

public TcpTransport()

Method Detail

isLocal

public boolean isLocal(Transport.ConnectionInfo connectionInfo)
                throws IOException

Determine whether this transport connecting according to connectionInfo is to a node on the current machine; results are cached. According to http://redmine.named-data.net/projects/nfd/wiki/ScopeControl#local-face, TCP transports with a loopback address are local. If connectionInfo contains a host name, InetAddress will do a blocking DNS lookup; otherwise it will parse the IP address and examine the first octet to determine if it is a loopback address (e.g. first octet == 127).

Specified by:

isLocal in class Transport

Parameters:

connectionInfo - A TcpTransport.ConnectionInfo with the host to check.

Returns:

True if the host is local, false if not.

Throws:

IOException

isAsync

public boolean isAsync()

Override to return false since connect does not need to use the onConnected callback.

Specified by:

isAsync in class Transport

Returns:

False.

connect

public void connect(Transport.ConnectionInfo connectionInfo,
           ElementListener elementListener,
           Runnable onConnected)
             throws IOException

Connect according to the info in ConnectionInfo, and use elementListener.

Overrides:

connect in class Transport

Parameters:

connectionInfo - A TcpTransport.ConnectionInfo.

elementListener - The ElementListener must remain valid during the life of this object.

onConnected - If not null, this calls onConnected.run() when the connection is established.

Throws:

IOException - For I/O error.

send

public void send(ByteBuffer data)
          throws IOException

Send data to the host

Overrides:

send in class Transport

Parameters:

data - The buffer of data to send. This reads from position() to limit(), but does not change the position.

Throws:

IOException - For I/O error.

processEvents

public void processEvents()
                   throws IOException,
                          EncodingException

Process any data to receive. For each element received, call elementListener.onReceivedElement. This is non-blocking and will return immediately if there is no data to receive. You should normally not call this directly since it is called by Face.processEvents. If you call this from an main event loop, you may want to catch and log/disregard all exceptions.

Specified by:

processEvents in class Transport

Throws:

IOException - For I/O error.

EncodingException - For invalid encoding.

getIsConnected

public boolean getIsConnected()
                       throws IOException

Check if the transport is connected.

Overrides:

getIsConnected in class Transport

Returns:

True if connected.

Throws:

IOException

close

public void close()
           throws IOException

Close the connection. If not connected, this does nothing.

Overrides:

close in class Transport

Throws:

IOException - For I/O error.

getIsLocal

public static boolean getIsLocal(String host)
                          throws IOException

A static method to determine whether the host is on the current machine. Results are not cached. According to http://redmine.named-data.net/projects/nfd/wiki/ScopeControl#local-face, TCP transports with a loopback address are local. If connectionInfo contains a host name, InetAddress will do a blocking DNS lookup; otherwise it will parse the IP address and examine the first octet to determine if it is a loopback address (e.g. first octet == 127).

Parameters:

host - The host to check.

Returns:

True if the host is local, False if not.

Throws:

IOException