com.mongodb.connection

Class KillCursorsMessage

java.lang.Object

com.mongodb.connection.RequestMessage

com.mongodb.connection.KillCursorsMessage

class KillCursorsMessage
extends RequestMessage

An OP_KILL_CURSOR message.

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.connection.RequestMessage

RequestMessage.EncodingMetadata, RequestMessage.OpCode

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.Long>	cursors

Fields inherited from class com.mongodb.connection.RequestMessage

REQUEST_ID

Constructor Summary

Constructors

Constructor and Description
KillCursorsMessage(java.util.List<java.lang.Long> cursors) Construct an instance.

Method Summary

Modifier and Type	Method and Description
protected RequestMessage	encodeMessageBody(BsonOutput bsonOutput, int messageStartPosition) Encode the message body to the given output.
protected RequestMessage.EncodingMetadata	encodeMessageBodyWithMetadata(BsonOutput bsonOutput, int messageStartPosition) Encode the message body to the given output.
private void	writeKillCursorsPrologue(int numCursors, BsonOutput bsonOutput)

Methods inherited from class com.mongodb.connection.RequestMessage

addCollectibleDocument, addDocument, backpatchMessageLength, encode, encodeWithMetadata, getCodec, getCollectionName, getCurrentGlobalId, getId, getNamespace, getOpCode, getSettings, writeMessagePrologue

Methods inherited from class java.lang.Object

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

Field Detail

cursors

private final java.util.List<java.lang.Long> cursors

Constructor Detail

KillCursorsMessage

public KillCursorsMessage(java.util.List<java.lang.Long> cursors)

Construct an instance.

Parameters:

cursors - the list of cursors to kill

Method Detail

encodeMessageBody

protected RequestMessage encodeMessageBody(BsonOutput bsonOutput,
                                           int messageStartPosition)

Description copied from class: RequestMessage

Encode the message body to the given output.

Specified by:

encodeMessageBody in class RequestMessage

Parameters:

bsonOutput - the output

messageStartPosition - the start position of the message

Returns:

the next message to encode, if the contents of this message need to overflow into the next

encodeMessageBodyWithMetadata

protected RequestMessage.EncodingMetadata encodeMessageBodyWithMetadata(BsonOutput bsonOutput,
                                                                        int messageStartPosition)

Description copied from class: RequestMessage

Encode the message body to the given output.

Specified by:

encodeMessageBodyWithMetadata in class RequestMessage

Parameters:

bsonOutput - the output

messageStartPosition - the start position of the message

Returns:

the encoding metadata

writeKillCursorsPrologue

private void writeKillCursorsPrologue(int numCursors,
                                      BsonOutput bsonOutput)