net.named_data.jndn.transport

Class Transport

java.lang.Object

net.named_data.jndn.transport.Transport

Direct Known Subclasses:

AsyncTcpTransport, TcpTransport, UdpTransport

public abstract class Transport
extends Object

A Transport object is used by Face to send packets and to listen for incoming packets. See connect() and processEvents() for more details.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Transport.ConnectionInfo A Transport.ConnectionInfo is a base class for connection information used by subclasses of Transport.

Constructor Summary

Constructors

Constructor and Description
Transport()

Method Summary

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.
abstract boolean	isAsync() Check if this transport is async where connect needs to use the onConnected callback.
abstract boolean	isLocal(Transport.ConnectionInfo connectionInfo) Determine whether this transport connecting according to connectionInfo is to a node on the current machine.
abstract 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

Transport

public Transport()

Method Detail

isLocal

public abstract boolean isLocal(Transport.ConnectionInfo connectionInfo)
                         throws IOException

Determine whether this transport connecting according to connectionInfo is to a node on the current machine. This affects the processing of Face.registerPrefix(): if the NFD is local, registration occurs with the '/localhost/nfd...' prefix; if non-local, the library will attempt to use remote prefix registration using '/localhop/nfd...'

Parameters:

connectionInfo - A ConnectionInfo with the host to check.

Returns:

True if the host is local, false if not.

Throws:

IOException

isAsync

public abstract boolean isAsync()

Check if this transport is async where connect needs to use the onConnected callback.

Returns:

True if transport connect is async, false if not.

connect

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

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

Parameters:

connectionInfo - An object of a subclass of 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. This is needed if isAsync() is true.

Throws:

IOException - For I/O error.

send

public void send(ByteBuffer data)
          throws IOException

Send data to the host

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 abstract void processEvents()
                            throws IOException,
                                   EncodingException

Process any data to receive. For each element received, call elementListener.onReceivedElement. This is non-blocking and will silently time out after a brief period if there is no data to receive. You should repeatedly call this from an event loop. 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.

Throws:

IOException - For I/O error.

EncodingException - For invalid encoding.

getIsConnected

public boolean getIsConnected()
                       throws IOException

Check if the transport is connected.

Returns:

True if connected.

Throws:

IOException

close

public void close()
           throws IOException

Close the connection. This base class implementation does nothing, but your derived class can override.

Throws:

IOException - For I/O error.