.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Device::Modem::Protocol::Xmodem 3pm"
.TH Device::Modem::Protocol::Xmodem 3pm "2005-04-30" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Device::Modem::Protocol::Xmodem
.SH "Xmodem::Block"
.IX Header "Xmodem::Block"
Class that represents a single Xmodem data block.
.Sh "Synopsis"
.IX Subsection "Synopsis"
.Vb 11
\&        my $b = Xmodem::Block\->new( 1, \(aqMy Data...<until\-128\-chars>...\(aq );
\&        if( defined $b ) {
\&                # Ok, block instanced, verify its checksum
\&                if( $b\->verify( \(aqchecksum\(aq, <my_chksum> ) ) {
\&                        ...
\&                } else {
\&                        ...
\&                }
\&        } else {
\&                # No block
\&        }
.Ve
.PP
.Vb 4
\&        # Calculate checksum, crc16, 32, ...
\&        $crc16 = $b\->crc16();
\&        $crc32 = $b\->crc32();
\&        $chksm = $b\->checksum();
.Ve
.SH "Xmodem::Buffer"
.IX Header "Xmodem::Buffer"
Class that implements an Xmodem receive buffer of data blocks. Every block of data
is represented by a \f(CW\*(C`Xmodem::Block\*(C'\fR object.
.PP
Blocks can be \fBpush\fRed and \fBpop\fRped from the buffer. You can retrieve the \fBlast\fR
block, or the list of \fBblocks\fR from buffer.
.Sh "Synopsis"
.IX Subsection "Synopsis"
.Vb 2
\&        my $buf = Xmodem::Buffer\->new();
\&        my $b1  = Xmodem::Block\->new(1, \(aqData...\(aq);
.Ve
.PP
.Vb 1
\&        $buf\->push($b1);
.Ve
.PP
.Vb 2
\&        my $b2  = Xmodem::Block\->new(2, \(aqMore data...\(aq);
\&        $buf\->push($b2);
.Ve
.PP
.Vb 1
\&        my $last_block = $buf\->last();
.Ve
.PP
.Vb 1
\&        print \(aqnow I have \(aq, scalar($buf\->blocks()), \(aq in the buffer\(aq;
.Ve
.PP
.Vb 1
\&        # TODO document replace() function ???
.Ve
.SH "Xmodem::Constants"
.IX Header "Xmodem::Constants"
Package that contains all useful Xmodem protocol constants used in handshaking and
data blocks encoding procedures
.Sh "Synopsis"
.IX Subsection "Synopsis"
.Vb 6
\&        Xmodem::Constants::soh ........... \(aqstart of header\(aq
\&        Xmodem::Constants::eot ........... \(aqend of trasmission\(aq
\&        Xmodem::Constants::ack ........... \(aqacknowlegded\(aq
\&        Xmodem::Constants::nak ........... \(aqnot acknowledged\(aq
\&        Xmodem::Constants::can ........... \(aqcancel\(aq
\&        Xmodem::Constants::C   ........... `C\(aq ASCII char
.Ve
.PP
.Vb 3
\&        Xmodem::Constants::XMODEM ........ basic xmodem protocol
\&        Xmodem::Constants::XMODEM_1K ..... xmodem protocol with 1k blocks
\&        Xmodem::Constants::XMODEM_CRC .... xmodem protocol with CRC checks
.Ve
.PP
.Vb 3
\&        Xmodem::Constants::CHECKSUM ...... type of block checksum
\&        Xmodem::Constants::CRC16 ......... type of block crc16
\&        Xmodem::Constants::CRC32 ......... type of block crc32
.Ve
.SH "Xmodem::Receiver"
.IX Header "Xmodem::Receiver"
Control class to initiate and complete a \f(CW\*(C`X\-modem\*(C'\fR file transfer in receive mode
.Sh "Synopsis"
.IX Subsection "Synopsis"
.Vb 5
\&        my $recv = Xmodem::Receiver\->new(
\&                modem    => {Device::Modem object},
\&                filename => \(aqname of file\(aq,
\&                XXX protocol => \(aqxmodem\(aq | \(aqxmodem\-crc\(aq, | \(aqxmodem\-1k\(aq
\&        );
.Ve
.PP
.Vb 1
\&        $recv\->run();
.Ve
.Sh "Object methods"
.IX Subsection "Object methods"
.IP "\fIabort_transfer()\fR" 4
.IX Item "abort_transfer()"
Sends a \fBcancel\fR char (\f(CW\*(C`can\*(C'\fR), that signals to sender that transfer is aborted. This is
issued if we receive a bad block number, which usually means we got a bad line.
.IP "\fImodem()\fR" 4
.IX Item "modem()"
Returns the underlying Device::Modem object.
.IP "\fIreceive_message()\fR" 4
.IX Item "receive_message()"
Retreives message from modem and if a block is detected it breaks it into appropriate
parts.
.IP "\fIrun()\fR" 4
.IX Item "run()"
Starts a new transfer until file receive is complete. The only parameter accepted
is the (optional) local filename to be written.
.IP "\fIsend_ack()\fR" 4
.IX Item "send_ack()"
Sends an acknowledge (\f(CW\*(C`ack\*(C'\fR) char, to signal that we received and stored a correct block
Resets count of timeouts and returns the \f(CW\*(C`Xmodem::Block\*(C'\fR object of the data block
received.
.IP "\fIsend_timeout()\fR" 4
.IX Item "send_timeout()"
Sends a \fBtimeout\fR (\f(CW\*(C`nak\*(C'\fR) char, to signal that we received a bad block header (either
a bad start char or a bad block number), or a bad data checksum. Increments count
of timeouts and at ten timeouts, aborts transfer.
.Sh "See also"
.IX Subsection "See also"
.IP "\- Device::Modem" 4
.IX Item "- Device::Modem"