package protocol
- Alphabetic
- By Inheritance
- protocol
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- trait ChannelBufferReadable[T] extends AnyRef
A constructor of T instances from a ByteBuf.
A constructor of T instances from a ByteBuf.
- T
type which instances can be constructed with this.
- trait ChannelBufferWritable extends AnyRef
Something that can be written into a ByteBuf.
- sealed trait CollectionAwareRequestOp extends RequestOp
A request that needs to know the full collection name.
- case class Delete(fullCollectionName: String, flags: Int) extends WriteRequestOp with Product with Serializable
Delete operation.
Delete operation.
- flags
operation flags.
- 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.
- case class Insert(flags: Int, fullCollectionName: String) extends WriteRequestOp with Product with Serializable
Insert operation.
Insert operation.
- flags
Operation flags.
- 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.
- 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.
- sealed trait MongoWireVersion extends Ordered[MongoWireVersion]
- sealed trait Op extends AnyRef
A Mongo Wire Protocol operation
- case class Query(flags: Int, fullCollectionName: String, numberToSkip: Int, numberToReturn: Int) extends CollectionAwareRequestOp with Product with Serializable
Query operation.
Query operation.
- flags
the operation flags
- fullCollectionName
the full name of the queried collection
- numberToSkip
the number of documents to skip in the response.
- numberToReturn
The number of documents to return in the response. 0 means the server will choose.
- 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.
- case class ReplyDocumentIteratorExhaustedException(cause: Exception) extends Exception with Product with Serializable
- case class Request(requestID: Int, responseTo: Int, op: RequestOp, documents: BufferSequence, readPreference: ReadPreference = ReadPreference.primary, channelIdHint: Option[ChannelId] = None) extends ChannelBufferWritable with Product with Serializable
Request message.
Request message.
- requestID
the ID of this request, so that the response may be identifiable. Should be strictly positive.
- op
request operation.
- documents
body of this request, a ByteBuf containing 0, 1, or many documents.
- channelIdHint
a hint for sending this request on a particular channel.
- case class RequestMaker(op: RequestOp, documents: BufferSequence = BufferSequence.empty, readPreference: ReadPreference = ReadPreference.primary, channelIdHint: Option[ChannelId] = None) extends Product with Serializable
A helper to build requests.
A helper to build requests.
- op
write operation.
- documents
body of this request, a ByteBuf containing 0, 1, or many documents.
- channelIdHint
a hint for sending this request on a particular channel.
- 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.
- implicit final class RichBuffer extends AnyVal
- case class Update(fullCollectionName: String, flags: Int) extends WriteRequestOp with Product with Serializable
Update operation.
Update operation.
- flags
Operation flags.
- sealed trait WriteRequestOp extends CollectionAwareRequestOp
A request that will perform a write on the database
Deprecated Type Members
- 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.api.commands.GetLastError command after).
A helper to build write request which result needs to be checked (by sending a reactivemongo.api.commands.GetLastError command after).
- op
write operation.
- documents
body of this request, a ByteBuf containing 0, 1, or many documents.
- getLastError
a
GetLastErrorcommand message.
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) Unused
- sealed abstract class Response extends Product4[MessageHeader, Reply, ByteBuf, ResponseInfo] with Serializable
A Mongo Wire Protocol Response messages.
A Mongo Wire Protocol Response messages.
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) Internal: will be made private
Value Members
- object MessageHeader extends ChannelBufferReadable[MessageHeader] with Serializable
Header deserializer from a ByteBuf.
- object MongoWireVersion
- object QueryFlags
Query flags.
- object Reply extends ChannelBufferReadable[Reply] with Serializable
- object ReplyDocumentIterator
- object Request extends Serializable
- object UpdateFlags
Deprecated Value Members
- object Response extends Serializable
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) Internal: will be made private
- object ResponseInfo extends AbstractFunction1[ChannelId, ResponseInfo]
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) Internal: will be made private