com.allanbank.mongodb.client.message

Class Header

java.lang.Object

com.allanbank.mongodb.client.message.Header

public class Header
extends Object

The header of a message.

 
 struct MsgHeader {
     int32   messageLength; // total message size, including this
     int32   requestID;     // identifier for this message
     int32   responseTo;    // requestID from the original request
                            //   (used in reponses from db)
     int32   opCode;        // request type - see table below
 }
 
 

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE The size of a message header.

Constructor Summary

Constructors

Constructor and Description
Header(BsonInputStream in) Creates a new header.
Header(int length, int requestId, int responseId, Operation operation) Creates a new header.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
int	getLength() Returns the length of the message in bytes.
Operation	getOperation() Returns the operation for the message.
int	getRequestId() Returns the request id for the message.
int	getResponseId() Returns the response id for the message.
int	hashCode() Computes a reasonable hash code.

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The size of a message header.

See Also:

Constant Field Values

Constructor Detail

Header

public Header(BsonInputStream in)
       throws IOException

Creates a new header.

Parameters:

in - The stream to read the header from.

Throws:

IOException - On a failure reading the header.

Header

public Header(int length,
      int requestId,
      int responseId,
      Operation operation)

Creates a new header.

Parameters:

length - The length of the message in bytes.

requestId - The request id for the message.

responseId - The response id for the message.

operation - The operation for the message.

Method Detail

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getLength

public int getLength()

Returns the length of the message in bytes. This includes the SIZE of the header.

Returns:

The length of the message in bytes.

getOperation

public Operation getOperation()

Returns the operation for the message.

Returns:

The operation for the message.

getRequestId

public int getRequestId()

Returns the request id for the message.

Returns:

The request id for the message.

getResponseId

public int getResponseId()

Returns the response id for the message.

Returns:

The response id for the message.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Object

Returns:

The hash code value.