org.apache.avro.ipc
Class SocketTransceiver

java.lang.Object
  org.apache.avro.ipc.Transceiver
      org.apache.avro.ipc.SocketTransceiver

All Implemented Interfaces:

Closeable

public class SocketTransceiver
extends Transceiver

A socket-based Transceiver implementation. This uses a simple, non-standard wire protocol and is not intended for production services.

Constructor Summary

SocketTransceiver(SocketAddress address)

SocketTransceiver(SocketChannel channel)

Method Summary

void	close()
Protocol	getRemote() Returns the protocol passed to Transceiver.setRemote(Protocol).
String	getRemoteName()
boolean	isConnected() True if a handshake has been completed for this connection.
List<ByteBuffer>	readBuffers() Called by the default definition of Transceiver.transceive(List).
void	setRemote(Protocol remote) Called with the remote protocol when a handshake has been completed.
void	writeBuffers(List<ByteBuffer> buffers) Called by Requestor.request(String,Object) for one-way messages.

Methods inherited from class org.apache.avro.ipc.Transceiver

transceive

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketTransceiver

public SocketTransceiver(SocketAddress address)
                  throws IOException

Throws:

IOException

SocketTransceiver

public SocketTransceiver(SocketChannel channel)
                  throws IOException

Throws:

IOException

Method Detail

getRemoteName

public String getRemoteName()

Specified by:

getRemoteName in class Transceiver

readBuffers

public List<ByteBuffer> readBuffers()
                             throws IOException

Description copied from class: Transceiver

Called by the default definition of Transceiver.transceive(List).

Specified by:

readBuffers in class Transceiver

Throws:

IOException

writeBuffers

public void writeBuffers(List<ByteBuffer> buffers)
                  throws IOException

Description copied from class: Transceiver

Called by Requestor.request(String,Object) for one-way messages.

Specified by:

writeBuffers in class Transceiver

Throws:

IOException

isConnected

public boolean isConnected()

Description copied from class: Transceiver

True if a handshake has been completed for this connection. Used to determine whether a handshake need be completed prior to a one-way message. Requests and responses are always prefixed by handshakes, but one-way messages. If the first request sent over a connection is one-way, then a handshake-only response is returned. Subsequent one-way messages over the connection will have no response data sent. Returns false by default.

Overrides:

isConnected in class Transceiver

setRemote

public void setRemote(Protocol remote)

Description copied from class: Transceiver

Called with the remote protocol when a handshake has been completed. After this has been called and while a connection is maintained, Transceiver.isConnected() should return true and #getRemote() should return this protocol. Does nothing by default.

Overrides:

setRemote in class Transceiver

getRemote

public Protocol getRemote()

Description copied from class: Transceiver

Returns the protocol passed to Transceiver.setRemote(Protocol). Throws IllegalStateException by default.

Overrides:

getRemote in class Transceiver

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Overrides:

close in class Transceiver

Throws:

IOException