Dart Documentation › mongo_dart › MongoKillCursorsMessage

MongoKillCursorsMessage class 

class MongoKillCursorsMessage extends MongoMessage{
 int cursorId;
 MongoKillCursorsMessage(
           this.cursorId
           ){
   opcode = MongoMessage.KillCursors;
 }
 int get messageLength{
   return 16+4+4+8;
 }
 BsonBinary serialize(){
   BsonBinary buffer = new BsonBinary(messageLength);
   writeMessageHeaderTo(buffer);
   buffer.writeInt(0);
   buffer.writeInt(1);
   buffer.writeInt64(cursorId);
   buffer.offset = 0;
   return buffer;
 }
 String toString(){
   return "MongoKillCursorsMessage($requestId, $cursorId)";
 }

}

Extends

MongoMessage > MongoKillCursorsMessage

Constructors

new MongoKillCursorsMessage(int cursorId) #

Creates a new Object instance.

Object instances have no meaningful state, and are only useful through their identity. An Object instance is equal to itself only.

docs inherited from Object 
MongoKillCursorsMessage(
         this.cursorId
         ){
 opcode = MongoMessage.KillCursors;
}

Properties

int cursorId # 

int cursorId

final int messageLength # 

int get messageLength{
 return 16+4+4+8;
}

int opcode #

inherited from MongoMessage 
int opcode = MongoMessage.Reply

final int requestId #

inherited from MongoMessage 
int get requestId{
 if (_requestId == null){
   _requestId = _Statics.nextRequestId;
 }
 return _requestId;
}

int responseTo #

inherited from MongoMessage 
int responseTo

Methods

MongoMessage deserialize(BsonBinary buffer) #

inherited from MongoMessage 
MongoMessage deserialize(BsonBinary buffer){
 throw new MongoDartError('Must be implemented');
}

dynamic readMessageHeaderFrom(BsonBinary buffer) #

inherited from MongoMessage 
readMessageHeaderFrom(BsonBinary buffer)
{
   _messageLength = buffer.readInt32();
   _requestId = buffer.readInt32();
   responseTo = buffer.readInt32();
   int opcodeFromWire = buffer.readInt32();
   if (opcodeFromWire != opcode)
   {
       throw new MongoDartError('Expected $opcode in Message header. Got $opcodeFromWire');
   }
}

BsonBinary serialize() #

BsonBinary serialize(){
 BsonBinary buffer = new BsonBinary(messageLength);
 writeMessageHeaderTo(buffer);
 buffer.writeInt(0);
 buffer.writeInt(1);
 buffer.writeInt64(cursorId);
 buffer.offset = 0;
 return buffer;
}

String toString() #

Returns a string representation of this object.

docs inherited from Object 
String toString(){
 return "MongoKillCursorsMessage($requestId, $cursorId)";
}

dynamic writeMessageHeaderTo(BsonBinary buffer) #

inherited from MongoMessage 
writeMessageHeaderTo(BsonBinary buffer)
{
   buffer.writeInt(messageLength); // messageLength will be backpatched later
   buffer.writeInt(requestId);
   buffer.writeInt(0); // responseTo not used in requests sent by client
   buffer.writeInt(opcode);
   if (messageLength < 0){
     throw new MongoDartError('Error in message length');
   }
}