net.razorvine.pyro

Class Message

java.lang.Object

net.razorvine.pyro.Message

public class Message
extends java.lang.Object

Pyro wire protocol message.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,byte[]>	annotations
int	annotations_size
byte[]	data
int	data_size
int	flags
static int	FLAGS_BATCH
static int	FLAGS_COMPRESSED
static int	FLAGS_EXCEPTION
static int	FLAGS_ONEWAY
static int	HEADER_SIZE
static int	MSG_CONNECT
static int	MSG_CONNECTFAIL
static int	MSG_CONNECTOK
static int	MSG_INVOKE
static int	MSG_PING
static int	MSG_RESULT
int	seq
int	serializer_id
static int	SERIALIZER_JSON
static int	SERIALIZER_MARSHAL
static int	SERIALIZER_PICKLE
static int	SERIALIZER_SERPENT
int	type

Constructor Summary

Constructors

Constructor and Description
Message(int msgType, byte[] databytes, int serializer_id, int flags, int seq, java.util.Map<java.lang.String,byte[]> annotations) construct a full wire message including data and annotations payloads.
Message(int msgType, int serializer_id, int flags, int seq) construct a header-type message, without data and annotations payload.

Method Summary

Methods

Modifier and Type	Method and Description
static Message	from_header(byte[] header) Parses a message header.
byte[]	get_annotations_bytes()
byte[]	get_header_bytes()
protected byte[]	hmac() returns the hmac of the data and the annotation chunk values (except HMAC chunk itself)
static Message	recv(java.io.InputStream connection, int[] requiredMsgTypes) Receives a pyro message from a given connection.
byte[]	to_bytes() creates a byte stream containing the header followed by annotations (if any) followed by the data
static void	TraceMessageRecv(int sequenceNr, byte[] headerdata, byte[] annotations, byte[] data)
static void	TraceMessageSend(int sequenceNr, byte[] headerdata, byte[] annotations, byte[] data)

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_SIZE

public static final int HEADER_SIZE

See Also:

Constant Field Values

MSG_CONNECT

public static final int MSG_CONNECT

See Also:

Constant Field Values

MSG_CONNECTOK

public static final int MSG_CONNECTOK

See Also:

Constant Field Values

MSG_CONNECTFAIL

public static final int MSG_CONNECTFAIL

See Also:

Constant Field Values

MSG_INVOKE

public static final int MSG_INVOKE

See Also:

Constant Field Values

MSG_RESULT

public static final int MSG_RESULT

See Also:

Constant Field Values

MSG_PING

public static final int MSG_PING

See Also:

Constant Field Values

FLAGS_EXCEPTION

public static final int FLAGS_EXCEPTION

See Also:

Constant Field Values

FLAGS_COMPRESSED

public static final int FLAGS_COMPRESSED

See Also:

Constant Field Values

FLAGS_ONEWAY

public static final int FLAGS_ONEWAY

See Also:

Constant Field Values

FLAGS_BATCH

public static final int FLAGS_BATCH

See Also:

Constant Field Values

SERIALIZER_SERPENT

public static final int SERIALIZER_SERPENT

See Also:

Constant Field Values

SERIALIZER_JSON

public static final int SERIALIZER_JSON

See Also:

Constant Field Values

SERIALIZER_MARSHAL

public static final int SERIALIZER_MARSHAL

See Also:

Constant Field Values

SERIALIZER_PICKLE

public static final int SERIALIZER_PICKLE

See Also:

Constant Field Values

type

public int type

flags

public int flags

data

public byte[] data

data_size

public int data_size

annotations_size

public int annotations_size

serializer_id

public int serializer_id

seq

public int seq

annotations

public java.util.Map<java.lang.String,byte[]> annotations

Constructor Detail

Message

public Message(int msgType,
       int serializer_id,
       int flags,
       int seq)

construct a header-type message, without data and annotations payload.

Message

public Message(int msgType,
       byte[] databytes,
       int serializer_id,
       int flags,
       int seq,
       java.util.Map<java.lang.String,byte[]> annotations)

construct a full wire message including data and annotations payloads.

Method Detail

hmac

protected byte[] hmac()

returns the hmac of the data and the annotation chunk values (except HMAC chunk itself)

to_bytes

public byte[] to_bytes()

creates a byte stream containing the header followed by annotations (if any) followed by the data

get_header_bytes

public byte[] get_header_bytes()

get_annotations_bytes

public byte[] get_annotations_bytes()

from_header

public static Message from_header(byte[] header)

Parses a message header. Does not yet process the annotations chunks and message data.

recv

public static Message recv(java.io.InputStream connection,
           int[] requiredMsgTypes)
                    throws java.io.IOException

Receives a pyro message from a given connection. Accepts the given message types (None=any, or pass a sequence). Also reads annotation chunks and the actual payload data. Validates a HMAC chunk if present.

Throws:

java.io.IOException

TraceMessageSend

public static void TraceMessageSend(int sequenceNr,
                    byte[] headerdata,
                    byte[] annotations,
                    byte[] data)
                             throws java.io.IOException

Throws:

java.io.IOException

TraceMessageRecv

public static void TraceMessageRecv(int sequenceNr,
                    byte[] headerdata,
                    byte[] annotations,
                    byte[] data)
                             throws java.io.IOException

Throws:

java.io.IOException