com.allanbank.mongodb.client.message

Class KillCursors

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.KillCursors

All Implemented Interfaces:

Message

public class KillCursors
extends AbstractMessage

Message to killcursors that a client no longer needs.

 
 struct {
     MsgHeader header;            // standard message header
     int32     ZERO;              // 0 - reserved for future use
     int32     numberOfCursorIDs; // number of cursorIDs in message
     int64*    cursorIDs;         // sequence of cursorIDs to close
 }
 
 

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
KillCursors(BsonInputStream in) Creates a new KillCursors.
KillCursors(long[] cursorIds, ReadPreference readPreference) Creates a new KillCursors.

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[]	getCursorIds() Returns the ids of the cursors to be killed.
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

KillCursors

public KillCursors(BsonInputStream in)
            throws IOException

Creates a new KillCursors.

Parameters:

in - The stream to read the kill_cursors message from.

Throws:

IOException - On a failure reading the kill_cursors message.

KillCursors

public KillCursors(long[] cursorIds,
           ReadPreference readPreference)

Creates a new KillCursors.

Parameters:

cursorIds - The ids of the cursors to kill.

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)

getCursorIds

public long[] getCursorIds()

Returns the ids of the cursors to be killed.

Returns:

The ids of the cursors to be killed.

getOperationName

public String getOperationName()

Returns a short name for the operation.

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

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 KillCursors.

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 ensure the size of the cursors ids array is not too large.

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 the kill_cursors 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 the kill_cursors 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)