zmq

Class Msg

java.lang.Object

zmq.Msg

Direct Known Subclasses:

Msg.Builder

public class Msg
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Msg.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMAND
static int	CREDENTIAL
static int	IDENTITY
static int	MORE
static int	SHARED

Constructor Summary

Constructors

Constructor and Description
Msg()
Msg(byte[] src)
Msg(ByteBuffer src)
Msg(int capacity)
Msg(Msg m)

Method Summary

Modifier and Type	Method and Description
ByteBuffer	buf()
boolean	check()
byte[]	data() Returns the message data.
SocketChannel	fd()
int	flags()
byte	get()
byte	get(int index)
int	getBytes(int index, byte[] dst, int off, int len)
int	getBytes(int index, ByteBuffer bb, int len)
int	getInt(int offset)
long	getLong(int offset)
Metadata	getMetadata()
int	getShort(int offset)
protected int	getWriteIndex()
boolean	hasMore()
void	initDelimiter()
boolean	isCommand()
boolean	isCredential()
boolean	isDelimiter()
boolean	isIdentity()
Msg	put(byte b)
Msg	put(byte[] src)
Msg	put(byte[] src, int off, int len)
Msg	put(ByteBuffer src)
Msg	put(ByteBuffer src, int off, int len)
Msg	put(int b)
protected Msg	put(int index, byte b)
Msg	putShortString(String data) Puts a string into the message, prefixed with its length.
void	resetFlags(int f)
void	resetMetadata()
void	setFd(SocketChannel fileDesc)
void	setFlags(int flags)
Msg	setMetadata(Metadata metadata)
protected void	setWriteIndex(int writeIndex)
int	size()
String	toString()
void	transfer(ByteBuffer destination, int srcOffset, int srcLength)

Methods inherited from class java.lang.Object

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

Field Detail

MORE

public static final int MORE

See Also:

Constant Field Values

COMMAND

public static final int COMMAND

See Also:

Constant Field Values

CREDENTIAL

public static final int CREDENTIAL

See Also:

Constant Field Values

IDENTITY

public static final int IDENTITY

See Also:

Constant Field Values

SHARED

public static final int SHARED

See Also:

Constant Field Values

Constructor Detail

Msg

public Msg()

Msg

public Msg(int capacity)

Msg

public Msg(byte[] src)

Msg

public Msg(ByteBuffer src)

Msg

public Msg(Msg m)

Method Detail

isIdentity

public boolean isIdentity()

isDelimiter

public boolean isDelimiter()

check

public boolean check()

flags

public int flags()

hasMore

public boolean hasMore()

isCommand

public boolean isCommand()

isCredential

public boolean isCredential()

setFlags

public void setFlags(int flags)

initDelimiter

public void initDelimiter()

data

public byte[] data()

Returns the message data. If possible, a reference to the data is returned, without copy. Otherwise a new byte array will be allocated and the data will be copied.

Returns:

the message data.

buf

public ByteBuffer buf()

size

public int size()

resetFlags

public void resetFlags(int f)

setFd

public void setFd(SocketChannel fileDesc)

fd

public SocketChannel fd()

getMetadata

public Metadata getMetadata()

setMetadata

public Msg setMetadata(Metadata metadata)

resetMetadata

public void resetMetadata()

get

public byte get()

get

public byte get(int index)

put

public Msg put(byte b)

put

public Msg put(int b)

put

protected Msg put(int index,
                  byte b)

put

public Msg put(byte[] src)

put

public Msg put(byte[] src,
               int off,
               int len)

put

public Msg put(ByteBuffer src,
               int off,
               int len)

put

public Msg put(ByteBuffer src)

getBytes

public int getBytes(int index,
                    byte[] dst,
                    int off,
                    int len)

getBytes

public int getBytes(int index,
                    ByteBuffer bb,
                    int len)

toString

public String toString()

Overrides:

toString in class Object

getWriteIndex

protected final int getWriteIndex()

setWriteIndex

protected final void setWriteIndex(int writeIndex)

getLong

public long getLong(int offset)

getInt

public int getInt(int offset)

getShort

public int getShort(int offset)

transfer

public void transfer(ByteBuffer destination,
                     int srcOffset,
                     int srcLength)

putShortString

public Msg putShortString(String data)

Puts a string into the message, prefixed with its length. Users shall size the message by adding 1 to the length of the string: It needs to be able to accommodate (data.length+1) more bytes.

Parameters:

data - a string shorter than 256 characters. If null, defaults to a no-op.

Returns:

the same message.