com.allanbank.mongodb.client.message

Class GetMore

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.GetMore

All Implemented Interfaces:

Message

public class GetMore
extends AbstractMessage

Message to getmore documents from a cursor. The format of the message is:

 
 struct {
     MsgHeader header;             // standard message header
     int32     ZERO;               // 0 - reserved for future use
     cstring   fullCollectionName; // "dbname.collectionname"
     int32     numberToReturn;     // number of documents to return
     int64     cursorID;           // cursorID from the OP_REPLY
 }
 
 

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 inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
GetMore(BsonInputStream in) Creates a new GetMore.
GetMore(String databaseName, String collectionName, long cursorId, int numberToReturn, ReadPreference readPreference) Creates a new GetMore.

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.
long	getCursorId() Returns the id of the cursor to get more documents from.
int	getNumberToReturn() Return the number of documents to return from the cursor.
String	getOperationName() Returns a short name for the operation.
int	hashCode() Computes a reasonable hash code.
int	size() Returns the total size of the message on the wire.
void	validateSize(int maxDocumentSize) Validates that the documents with the message do not exceed the maximum document size specified.
void	write(int messageId, BsonOutputStream out) Writes the message from the stream.
void	write(int messageId, BufferingBsonOutputStream out) Writes the message from the stream.

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

GetMore

public GetMore(BsonInputStream in)
        throws IOException

Creates a new GetMore.

Parameters:

in - The stream to read the get_more message from.

Throws:

IOException - On a failure reading the get_more message.

GetMore

public GetMore(String databaseName,
       String collectionName,
       long cursorId,
       int numberToReturn,
       ReadPreference readPreference)

Creates a new GetMore.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection.

cursorId - The id of the cursor.

numberToReturn - The number of documents to return.

readPreference - The preferences for which server to send the request.

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 AbstractMessage

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getCursorId

public long getCursorId()

Returns the id of the cursor to get more documents from.

Returns:

The id of the cursor to get more documents from.

getNumberToReturn

public int getNumberToReturn()

Return the number of documents to return from the cursor.

Returns:

The number of documents to return from the cursor.

getOperationName

public String getOperationName()

Returns a short name for the operation.

Overridden to return the name of the operation: "GET_MORE".

Returns:

A short name for the operation.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class AbstractMessage

Returns:

The hash code value.

size

public int size()

Returns the total size of the message on the wire.

Overridden to return the size of the GetMore.

Returns:

The size of the message on the wire.

validateSize

public void validateSize(int maxDocumentSize)
                  throws DocumentToLargeException

Validates that the documents with the message do not exceed the maximum document size specified.

Overrridden to be a no-op since the size of a GetMore is fixed.

Parameters:

maxDocumentSize - The maximum document size to validate against.

Throws:

DocumentToLargeException - If one of the documents in the message is too large or the documents in aggregate are too large.

write

public void write(int messageId,
         BsonOutputStream out)
           throws IOException

Writes the message from the stream. The message header is written by this method.

Overridden to write a get_more message.

Parameters:

messageId - The id to be assigned to the message.

out - The sink for data written.

Throws:

IOException - On an error writing to the stream.

See Also:

Message.write(int, BsonOutputStream)

write

public void write(int messageId,
         BufferingBsonOutputStream out)
           throws IOException

Writes the message from the stream. The message header is written by this method.

Overridden to write a get_more message.

Parameters:

messageId - The id to be assigned to the message.

out - The sink for data written.

Throws:

IOException - On an error writing to the stream.

See Also:

Message.write(int, BsonOutputStream)