org.zeromq.api

Interface Receiver

All Known Subinterfaces:

Socket

All Known Implementing Classes:

ManagedSocket

public interface Receiver

Socket capable of receiving message parts.

Method Summary

Modifier and Type	Method and Description
boolean	hasMoreToReceive() This receiver has more of a multi-part message waiting for receipt.
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.

Method Detail

receive

byte[] receive()

Receive a message part from a socket.

Returns:

The message bytes

receive

byte[] receive(MessageFlag flag)

Receive a message part from a socket.

Parameters:

flag - Flag controlling behavior of the receive operation

Returns:

The message bytes

receive

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

Receive a message part from a socket.

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

int receiveByteBuffer(ByteBuffer buf,
                      MessageFlag flag)

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

Parameters:

buf - The byte buffer

flag - Flag controlling behavior of the receive operation

Returns:

The number of bytes read, -1 on error

hasMoreToReceive

boolean hasMoreToReceive()

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

Returns:

true if there is more data, false otherwise

receiveMessage

Message receiveMessage()

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

Returns:

The full message (all frames) from the socket.

receiveMessage

Message receiveMessage(MessageFlag flag)

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

Parameters:

flag - Flag controlling behavior of the receive operation

Returns:

The full message (all frames) from the socket.

receiveRoutedMessage

RoutedMessage receiveRoutedMessage()

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

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

RoutedMessage receiveRoutedMessage(MessageFlag flag)

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

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.