public class ZFrame
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private byte[] |
data |
static int |
DONTWAIT |
private java.lang.String |
group |
private boolean |
more |
static int |
MORE |
static int |
REUSE |
private int |
routingId |
Modifier | Constructor and Description |
---|---|
protected |
ZFrame()
Class Constructor
Creates an empty frame.
|
|
ZFrame(byte[] data)
Class Constructor
Copies message data into ZFrame object
|
protected |
ZFrame(Msg msg)
Class Constructor
Uses internal Msg class to access routingId
|
|
ZFrame(java.lang.String data)
Class Constructor
Copies String into frame data
|
Modifier and Type | Method and Description |
---|---|
void |
destroy()
Destructor.
|
ZFrame |
duplicate()
Creates a new frame that duplicates an existing frame
|
boolean |
equals(java.lang.Object o) |
byte[] |
getData() |
java.lang.String |
getGroup()
Gets the group used for RADIO/DISH sockets.
|
int |
getRoutingId()
Return frame routing ID, if the frame came from a ZMQ_SERVER socket.
|
java.lang.String |
getString(java.nio.charset.Charset charset) |
boolean |
hasData()
Convenience method to ascertain if this frame contains some message data
|
int |
hashCode() |
boolean |
hasMore() |
boolean |
hasSameData(ZFrame other)
Returns true if both frames have byte - for byte identical data
|
void |
print(java.lang.String prefix) |
static ZFrame |
recvFrame(ZMQ.Socket socket)
Receives single frame from socket, returns the received frame object, or null if the recv
was interrupted.
|
static ZFrame |
recvFrame(ZMQ.Socket socket,
int flags)
Receive a new frame off the socket, Returns newly-allocated frame, or
null if there was no input waiting, or if the read was interrupted.
|
void |
reset(byte[] data)
Sets new contents for frame
|
void |
reset(java.lang.String data)
Sets new contents for frame
|
boolean |
send(ZMQ.Socket socket,
int flags)
Internal method to call org.zeromq.Socket send() method.
|
boolean |
sendAndDestroy(ZMQ.Socket socket)
Sends frame to socket if it contains data.
|
boolean |
sendAndDestroy(ZMQ.Socket socket,
int flags)
Sends frame to socket if it contains data.
|
boolean |
sendAndKeep(ZMQ.Socket socket)
Sends frame to socket if it contains any data.
|
boolean |
sendAndKeep(ZMQ.Socket socket,
int flags)
Sends frame to socket if it contains any data.
|
void |
setGroup(java.lang.String group)
Sets the group used for RADIO/DISH sockets.
|
void |
setRoutingId(int routingId)
Set routing ID on frame.
|
int |
size()
Returns byte size of frame, if set, else 0
|
boolean |
streq(java.lang.String str)
String equals.
|
java.lang.String |
strhex() |
java.lang.String |
toString()
Returns a human - readable representation of frame's data
|
public static final int MORE
public static final int REUSE
public static final int DONTWAIT
private boolean more
private byte[] data
private int routingId
private java.lang.String group
protected ZFrame()
public ZFrame(byte[] data)
data
- Data to copy into ZFrame objectpublic ZFrame(java.lang.String data)
data
- String to copy into ZFrame object as bytes, decoded using ZMQ.CHARSET
protected ZFrame(Msg msg)
msg
- internal Msg class to copy into Zframepublic int getRoutingId()
public void setRoutingId(int routingId)
routingId
- the routing IDpublic java.lang.String getGroup()
public void setGroup(java.lang.String group)
group
- the group name, or null to unset it.public void destroy()
public byte[] getData()
public java.lang.String getString(java.nio.charset.Charset charset)
public boolean hasMore()
public int size()
public boolean hasData()
public boolean send(ZMQ.Socket socket, int flags)
socket
- 0MQ socket to send onflags
- Valid send() method flags, defined in org.zeromq.ZMQ classpublic boolean sendAndKeep(ZMQ.Socket socket, int flags)
socket
- 0MQ socket to send frameflags
- Valid send() method flags, defined in org.zeromq.ZMQ classpublic boolean sendAndKeep(ZMQ.Socket socket)
socket
- 0MQ socket to send framepublic boolean sendAndDestroy(ZMQ.Socket socket, int flags)
socket
- 0MQ socket to send frameflags
- Valid send() method flags, defined in org.zeromq.ZMQ classpublic boolean sendAndDestroy(ZMQ.Socket socket)
socket
- 0MQ socket to send framepublic ZFrame duplicate()
public boolean hasSameData(ZFrame other)
other
- The other ZFrame to comparepublic void reset(java.lang.String data)
data
- New byte array contents for framepublic void reset(byte[] data)
data
- New byte array contents for framepublic java.lang.String strhex()
public boolean streq(java.lang.String str)
str
- String to compare with frame datapublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static ZFrame recvFrame(ZMQ.Socket socket)
socket
- Socket to read frompublic static ZFrame recvFrame(ZMQ.Socket socket, int flags)
socket
- Socket to read fromflags
- Pass flags to 0MQ socket.recv callpublic void print(java.lang.String prefix)