org.zeromq.jzmq

Class ManagedSocket

java.lang.Object

org.zeromq.jzmq.ManagedSocket

All Implemented Interfaces:

Closeable, AutoCloseable, Receiver, Sender, Socket

public class ManagedSocket
extends Object
implements Socket

Managed JZMQ Socket

Constructor Summary

Constructors

Constructor and Description
ManagedSocket(ManagedContext managedContext, org.zeromq.ZMQ.Socket socket)

Method Summary

Modifier and Type	Method and Description
void	close() Close this ØMQ Socket.
Context	getContext() Retrieve the owning Context for this Socket.
TransportType	getTransportType() Retrieve the type of transport this ØMQ Socket is using.
org.zeromq.ZMQ.Socket	getZMQSocket()
boolean	hasMoreToReceive() This receiver has more of a multi-part message waiting for receipt.
boolean	isActive() Retrieve the status of this ØMQ Socket.
byte[]	receive() Receive a message part from a socket.
int	receive(byte[] buf, int offset, int len, MessageFlag flag) Receive a message part from a socket.
byte[]	receive(MessageFlag flag) Receive a message part from a socket.
int	receiveByteBuffer(ByteBuffer buf, MessageFlag flag) Receive a message part from a socket into a byte buffer.
Message	receiveMessage() Receive the full message (all frames) from the socket.
Message	receiveMessage(MessageFlag flag) Receive the full message (all frames) from the socket.
RoutedMessage	receiveRoutedMessage() Receive a routed message (all frames) from the socket.
RoutedMessage	receiveRoutedMessage(MessageFlag flag) Receive a routed message (all frames) from the socket.
boolean	send(byte[] buf) Send a message part on a socket.
boolean	send(byte[] buf, int offset, int length, MessageFlag flag) Send a message part on a socket.
boolean	send(byte[] message, MessageFlag flag) Send a message part on a socket.
boolean	send(Message message) Send the full message (all frames) on the socket.
boolean	sendByteBuffer(ByteBuffer buf, MessageFlag flag) Send a message part on a socket from a byte buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedSocket

public ManagedSocket(ManagedContext managedContext,
                     org.zeromq.ZMQ.Socket socket)

Method Detail

getZMQSocket

public org.zeromq.ZMQ.Socket getZMQSocket()

Specified by:

getZMQSocket in interface Socket

isActive

public boolean isActive()

Description copied from interface: Socket

Retrieve the status of this ØMQ Socket.

Specified by:

isActive in interface Socket

Returns:

true if the Socket is open, false otherwise

receive

public byte[] receive()

Description copied from interface: Receiver

Receive a message part from a socket.

Specified by:

receive in interface Receiver

Returns:

The message bytes

receive

public byte[] receive(MessageFlag flag)

Description copied from interface: Receiver

Receive a message part from a socket.

Specified by:

receive in interface Receiver

Parameters:

flag - Flag controlling behavior of the receive operation

Returns:

The message bytes

receive

public int receive(byte[] buf,
                   int offset,
                   int len,
                   MessageFlag flag)

Description copied from interface: Receiver

Receive a message part from a socket.

Specified by:

receive in interface Receiver

Parameters:

buf - The byte buffer

offset - The buffer offset

len - The buffer length

flag - Flag controlling behavior of the receive operation

Returns:

The number of bytes read, -1 on error

receiveByteBuffer

public int receiveByteBuffer(ByteBuffer buf,
                             MessageFlag flag)

Description copied from interface: Receiver

Receive a message part from a socket into a byte buffer.

Specified by:

receiveByteBuffer in interface Receiver

Parameters:

buf - The byte buffer

flag - Flag controlling behavior of the receive operation

Returns:

The number of bytes read, -1 on error

hasMoreToReceive

public boolean hasMoreToReceive()

Description copied from interface: Receiver

This receiver has more of a multi-part message waiting for receipt.

Specified by:

hasMoreToReceive in interface Receiver

Returns:

true if there is more data, false otherwise

receiveMessage

public Message receiveMessage()

Description copied from interface: Receiver

Receive the full message (all frames) from the socket.

Specified by:

receiveMessage in interface Receiver

Returns:

The full message (all frames) from the socket.

receiveMessage

public Message receiveMessage(MessageFlag flag)

Description copied from interface: Receiver

Receive the full message (all frames) from the socket.

Specified by:

receiveMessage in interface Receiver

Parameters:

flag - Flag controlling behavior of the receive operation

Returns:

The full message (all frames) from the socket.

receiveRoutedMessage

public RoutedMessage receiveRoutedMessage()

Description copied from interface: Receiver

Receive a routed message (all frames) from the socket.

Specified by:

receiveRoutedMessage in interface Receiver

Returns:

The full message (all frames) from the socket, assuming it has been through a Router socket, and has routing frames associated with it.

receiveRoutedMessage

public RoutedMessage receiveRoutedMessage(MessageFlag flag)

Description copied from interface: Receiver

Receive a routed message (all frames) from the socket.

Specified by:

receiveRoutedMessage in interface Receiver

Parameters:

flag - Flag controlling behavior of the receive operation

Returns:

The full message (all frames) from the socket, assuming it has been through a Router socket, and has routing frames associated with it.

send

public boolean send(Message message)

Description copied from interface: Sender

Send the full message (all frames) on the socket.

Specified by:

send in interface Sender

Parameters:

message - The full message

Returns:

true if the operation was successful, false otherwise

send

public boolean send(byte[] buf)

Description copied from interface: Sender

Send a message part on a socket.

Specified by:

send in interface Sender

Parameters:

buf - The message bytes

Returns:

true if the operation was successful, false otherwise

send

public boolean send(byte[] message,
                    MessageFlag flag)

Description copied from interface: Sender

Send a message part on a socket.

Specified by:

send in interface Sender

Parameters:

message - The message bytes

flag - Flag controlling behavior of the send operation

Returns:

true if the operation was successful, false otherwise

send

public boolean send(byte[] buf,
                    int offset,
                    int length,
                    MessageFlag flag)

Description copied from interface: Sender

Send a message part on a socket.

Specified by:

send in interface Sender

Parameters:

buf - The message bytes

offset - The buffer offset

length - The buffer length

flag - Flag controlling behavior of the send operation

Returns:

true if the operation was successful, false otherwise

sendByteBuffer

public boolean sendByteBuffer(ByteBuffer buf,
                              MessageFlag flag)

Description copied from interface: Sender

Send a message part on a socket from a byte buffer.

Specified by:

sendByteBuffer in interface Sender

Parameters:

buf - The byte buffer

flag - Flag controlling behavior of the send operation

Returns:

true if the operation was successful, false otherwise

close

public void close()

Description copied from interface: Socket

Close this ØMQ Socket.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Socket

getContext

public Context getContext()

Description copied from interface: Socket

Retrieve the owning Context for this Socket.

Specified by:

getContext in interface Socket

Returns:

The ØMQ Context

getTransportType

public TransportType getTransportType()

Description copied from interface: Socket

Retrieve the type of transport this ØMQ Socket is using. UNIMPLEMENTED!

Specified by:

getTransportType in interface Socket

Returns:

The transport type used by this Socket