protocol

Type Members

1. trait ChannelBufferReadable[T] extends AnyRef

   

   A constructor of T instances from a ChannelBuffer.

   A constructor of T instances from a ChannelBuffer.

   T

   type which instances can be constructed with this.

2. trait ChannelBufferWritable extends AnyRef

   

   Something that can be written into a ChannelBuffer.

3. case class CheckedWriteRequest(op: WriteRequestOp, documents: BufferSequence, getLastError: GetLastError) extends Product with Serializable

   

   A helper to build write request which result needs to be checked (by sending a reactivemongo.core.commands.GetLastError command after).

   A helper to build write request which result needs to be checked (by sending a reactivemongo.core.commands.GetLastError command after).

   op

   write operation.

   documents

   body of this request, a ChannelBuffer containing 0, 1, or many documents.

   getLastError

   a reactivemongo.core.commands.GetLastError command message.

4. sealed trait CollectionAwareRequestOp extends RequestOp

   

   A request that needs to know the full collection name.

5. case class Delete(fullCollectionName: String, flags: Int) extends WriteRequestOp with Product with Serializable

   

   Delete operation.

   Delete operation.

   flags

   operation flags.

6. case class GetMore(fullCollectionName: String, numberToReturn: Int, cursorID: Long) extends CollectionAwareRequestOp with Product with Serializable

   

   GetMore operation.

   GetMore operation.

   Allows to get more data from a cursor.

   numberToReturn

   number of documents to return in the response. 0 means the server will choose.

7. case class Insert(flags: Int, fullCollectionName: String) extends WriteRequestOp with Product with Serializable

   

   Insert operation.

   Insert operation.

   flags

   Operation flags.

8. case class KillCursors(cursorIDs: Set[Long]) extends RequestOp with Product with Serializable

   

   KillCursors operation.

   KillCursors operation.

   cursorIDs

   ids of the cursors to kill. Should not be empty.

9. case class MessageHeader(messageLength: Int, requestID: Int, responseTo: Int, opCode: Int) extends ChannelBufferWritable with Product with Serializable

   

   Header of a Mongo Wire Protocol message.

   Header of a Mongo Wire Protocol message.

   messageLength

   length of this message.

   requestID

   id of this request (> 0 for request operations, else 0).

   responseTo

   id of the request that the message including this a response to (> 0 for reply operation, else 0).

   opCode

   operation code of this message.

10. sealed trait MongoWireVersion extends Ordered[MongoWireVersion]

    

11. sealed trait Op extends AnyRef

    

    A Mongo Wire Protocol operation

12. case class Query(flags: Int, fullCollectionName: String, numberToSkip: Int, numberToReturn: Int) extends CollectionAwareRequestOp with Product with Serializable

    

    Query operation.

    Query operation.

    flags

    Operation flags.

    numberToSkip

    number of documents to skip in the response.

    numberToReturn

    number of documents to return in the response. 0 means the server will choose.

13. case class Reply(flags: Int, cursorID: Long, startingFrom: Int, numberReturned: Int) extends Op with Product with Serializable

    

    Reply operation.

    Reply operation.

    flags

    The flags of this response.

    cursorID

    The cursor id. Strictly positive if a cursor has been created server side, 0 if none or exhausted.

    startingFrom

    The index the returned documents start from.

    numberReturned

    The number of documents that are present in this reply.

14. case class ReplyDocumentIteratorExhaustedException(cause: Exception) extends Exception with Product with Serializable

    

15. case class Request(requestID: Int, responseTo: Int, op: RequestOp, documents: BufferSequence, readPreference: ReadPreference = ReadPreference.primary, channelIdHint: Option[Int] = None) extends ChannelBufferWritable with Product with Serializable

    

    Request message.

    Request message.

    requestID

    id of this request, so that the response may be identifiable. Should be strictly positive.

    op

    request operation.

    documents

    body of this request, a ChannelBuffer containing 0, 1, or many documents.

    channelIdHint

    a hint for sending this request on a particular channel.

16. case class RequestMaker(op: RequestOp, documents: BufferSequence = BufferSequence.empty, readPreference: ReadPreference = ReadPreference.primary, channelIdHint: Option[Int] = None) extends Product with Serializable

    

    A helper to build requests.

    A helper to build requests.

    op

    write operation.

    documents

    body of this request, a ChannelBuffer containing 0, 1, or many documents.

    channelIdHint

    a hint for sending this request on a particular channel.

17. sealed trait RequestOp extends Op with ChannelBufferWritable

    

    A Mongo Wire Protocol request operation.

    A Mongo Wire Protocol request operation.

    Actually, all operations excepted Reply are requests.

18. case class Response(header: MessageHeader, reply: Reply, documents: ChannelBuffer, info: ResponseInfo) extends Product with Serializable

    

    A Mongo Wire Protocol Response messages.

    A Mongo Wire Protocol Response messages.

    header

    header of this response.

    reply

    the reply operation contained in this response.

    documents

    body of this response, a ChannelBuffer containing 0, 1, or many documents.

    info

    some meta information about this response, see reactivemongo.core.protocol.ResponseInfo.

19. case class ResponseInfo(channelId: Int) extends Product with Serializable

    

    Response meta information.

    Response meta information.

    channelId

    the id of the channel that carried this response.

20. implicit final class RichBuffer extends AnyVal

    

21. case class Update(fullCollectionName: String, flags: Int) extends WriteRequestOp with Product with Serializable

    

    Update operation.

    Update operation.

    flags

    Operation flags.

22. sealed trait WriteRequestOp extends CollectionAwareRequestOp

    

    A request that will perform a write on the database