.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::EPP::Protocol 3pm"
.TH Net::EPP::Protocol 3pm "2021-01-09" "perl v5.32.0" "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"
Net::EPP::Protocol \- Low\-level functions useful for both EPP clients and
servers.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&        #!/usr/bin/perl
\&        use Net::EPP::Protocol;
\&        use IO::Socket;
\&        use strict;
\&
\&        # create a socket:
\&
\&        my $socket = IO::Socket::INET\->new( ... );
\&
\&        # send a frame down the socket:
\&
\&        Net::EPP::Protocol\->send_frame($socket, $xml);
\&
\&        # get a frame from the socket:
\&
\&        my $xml = Net::EPP::Protocol\->get_frame($socket);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1EPP\s0 is the Extensible Provisioning Protocol. \s-1EPP\s0 (defined in \s-1RFC 4930\s0)
is an application layer client-server protocol for the provisioning and
management of objects stored in a shared central repository. Specified
in \s-1XML,\s0 the protocol defines generic object management operations and an
extensible framework that maps protocol operations to objects. As of
writing, its only well-developed application is the provisioning of
Internet domain names, hosts, and related contact details.
.PP
This module implements functions that are common to both \s-1EPP\s0 clients and
servers that implement the \s-1TCP\s0 transport as defined in \s-1RFC 4934.\s0 The
main consumer of this module is currently Net::EPP::Client.
.SH "VARIABLES"
.IX Header "VARIABLES"
.ie n .SS "$Net::EPP::Protocol::THRESHOLD"
.el .SS "\f(CW$Net::EPP::Protocol::THRESHOLD\fP"
.IX Subsection "$Net::EPP::Protocol::THRESHOLD"
At least one \s-1EPP\s0 server implementation sends an unframed plain text error
message when a client connects from an unauthorised address. As a result, when
the first four bytes of the message are unpacked, the client tries to read and
allocate a very large amount of memory.
.PP
If the apparent frame length received from a server exceeds the value of
\&\f(CW$Net::EPP::Protocol::THRESHOLD\fR, the \f(CW\*(C`get_frame()\*(C'\fR method will croak.
.PP
The default value is 1GB.
.SH "METHODS"
.IX Header "METHODS"
.Vb 1
\&        my $xml = Net::EPP::Protocol\->get_frame($socket);
.Ve
.PP
This method reads a frame from the socket and returns a scalar
containing the \s-1XML.\s0 \f(CW$socket\fR must be an IO::Handle or one of its
subclasses (ie \f(CW\*(C`IO::Socket::*\*(C'\fR).
.PP
If the transmission fails for whatever reason, this method will
\&\f(CW\*(C`croak()\*(C'\fR, so be sure to enclose it in an \f(CW\*(C`eval()\*(C'\fR.
.PP
.Vb 1
\&        Net::EPP::Protocol\->send_frame($socket, $xml);
.Ve
.PP
This method prepares an \s-1RFC 4934\s0 compliant \s-1EPP\s0 frame and transmits it to
the remote peer. \f(CW$socket\fR must be an IO::Handle or one of its
subclasses (ie \f(CW\*(C`IO::Socket::*\*(C'\fR).
.PP
If the transmission fails for whatever reason, this method will
\&\f(CW\*(C`croak()\*(C'\fR, so be sure to enclose it in an \f(CW\*(C`eval()\*(C'\fR. Otherwise, it will
return a true value.
.PP
.Vb 1
\&        my $frame = Net::EPP::Protocol\->prep_frame($xml);
.Ve
.PP
This method returns the \s-1XML\s0 frame in \*(L"wire format\*(R" with the protocol
header prepended to it. The return value can be printed directly to an
open socket, for example:
.PP
.Vb 1
\&        print STDOUT Net::EPP::Protocol\->prep_frame($frame\->toString);
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
CentralNic Ltd (<http://www.centralnic.com/>).
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This module is (c) 2016 CentralNic Ltd. This module is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Net::EPP::Client
.IP "\(bu" 4
RFCs 4930 and \s-1RFC 4934,\s0 available from <http://www.ietf.org/>.
.IP "\(bu" 4
The CentralNic \s-1EPP\s0 site at <http://www.centralnic.com/resellers/epp>.