.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Mango::Protocol 3pm"
.TH Mango::Protocol 3pm "2018-04-14" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mango::Protocol \- The MongoDB wire protocol
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mango::Protocol;
\&
\&  my $protocol = Mango::Protocol\->new;
\&  my $bytes    = $protocol\->query(1, \*(Aqfoo\*(Aq, {}, 0, 10, {}, {});
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mango::Protocol is a minimalistic implementation of the MongoDB wire
protocol.
.SH "METHODS"
.IX Header "METHODS"
Mango::Protocol inherits all methods from Mojo::Base and implements the
following new ones.
.SS "build_get_more"
.IX Subsection "build_get_more"
.Vb 1
\&  my $bytes = $protocol\->build_get_more($id, $name, $return, $cursor);
.Ve
.PP
Build message for \f(CW\*(C`GET_MORE\*(C'\fR operation.
.SS "build_kill_cursors"
.IX Subsection "build_kill_cursors"
.Vb 1
\&  my $bytes = $protocol\->build_kill_cursors($id, @ids);
.Ve
.PP
Build message for \f(CW\*(C`KILL_CURSORS\*(C'\fR operation.
.SS "build_query"
.IX Subsection "build_query"
.Vb 2
\&  my $bytes = $protocol\->build_query($id, $name, $flags, $skip, $return,
\&    $query, $fields);
.Ve
.PP
Build message for \f(CW\*(C`QUERY\*(C'\fR operation.
.SS "command_error"
.IX Subsection "command_error"
.Vb 1
\&  my $err = $protocol\->command_error($doc);
.Ve
.PP
Check document for command error.
.SS "next_id"
.IX Subsection "next_id"
.Vb 1
\&  my $id = $protocol\->next_id(23);
.Ve
.PP
Generate next id.
.SS "parse_reply"
.IX Subsection "parse_reply"
.Vb 1
\&  my $reply = $protocol\->parse_reply(\e$str);
.Ve
.PP
Extract and parse \f(CW\*(C`reply\*(C'\fR message.
.SS "query_failure"
.IX Subsection "query_failure"
.Vb 1
\&  my $err = $protocol\->query_failure($reply);
.Ve
.PP
Check reply for query failure.
.SS "write_error"
.IX Subsection "write_error"
.Vb 1
\&  my $err = $protocol\->write_error($doc);
.Ve
.PP
Check document for write error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mango, Mojolicious::Guides, <http://mojolicio.us>.