.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Tie::Handle 3pm"
.TH Tie::Handle 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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
Tie::Handle \- base class definitions for tied handles
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    package NewHandle;
\&    require Tie::Handle;
\&
\&    @ISA = qw(Tie::Handle);
\&
\&    sub READ { ... }            # Provide a needed method
\&    sub TIEHANDLE { ... }       # Overrides inherited method
\&
\&
\&    package main;
\&
\&    tie *FH, \*(AqNewHandle\*(Aq;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides some skeletal methods for handle-tying classes. See
perltie for a list of the functions required in tying a handle to a package.
The basic \fBTie::Handle\fR package provides a \f(CW\*(C`new\*(C'\fR method, as well as methods
\&\f(CW\*(C`TIEHANDLE\*(C'\fR, \f(CW\*(C`PRINT\*(C'\fR, \f(CW\*(C`PRINTF\*(C'\fR and \f(CW\*(C`GETC\*(C'\fR.
.PP
For developers wishing to write their own tied-handle classes, the methods
are summarized below. The perltie section not only documents these, but
has sample code as well:
.IP "TIEHANDLE classname, LIST" 4
.IX Item "TIEHANDLE classname, LIST"
The method invoked by the command \f(CW\*(C`tie *glob, classname\*(C'\fR. Associates a new
glob instance with the specified class. \f(CW\*(C`LIST\*(C'\fR would represent additional
arguments (along the lines of AnyDBM_File and compatriots) needed to
complete the association.
.IP "WRITE this, scalar, length, offset" 4
.IX Item "WRITE this, scalar, length, offset"
Write \fIlength\fR bytes of data from \fIscalar\fR starting at \fIoffset\fR.
.IP "PRINT this, LIST" 4
.IX Item "PRINT this, LIST"
Print the values in \fILIST\fR
.IP "PRINTF this, format, LIST" 4
.IX Item "PRINTF this, format, LIST"
Print the values in \fILIST\fR using \fIformat\fR
.IP "READ this, scalar, length, offset" 4
.IX Item "READ this, scalar, length, offset"
Read \fIlength\fR bytes of data into \fIscalar\fR starting at \fIoffset\fR.
.IP "READLINE this" 4
.IX Item "READLINE this"
Read a single line
.IP "GETC this" 4
.IX Item "GETC this"
Get a single character
.IP "CLOSE this" 4
.IX Item "CLOSE this"
Close the handle
.IP "OPEN this, filename" 4
.IX Item "OPEN this, filename"
(Re\-)open the handle
.IP "BINMODE this" 4
.IX Item "BINMODE this"
Specify content is binary
.IP "EOF this" 4
.IX Item "EOF this"
Test for end of file.
.IP "TELL this" 4
.IX Item "TELL this"
Return position in the file.
.IP "SEEK this, offset, whence" 4
.IX Item "SEEK this, offset, whence"
Position the file.
.Sp
Test for end of file.
.IP "DESTROY this" 4
.IX Item "DESTROY this"
Free the storage associated with the tied handle referenced by \fIthis\fR.
This is rarely needed, as Perl manages its memory quite well. But the
option exists, should a class wish to perform specific actions upon the
destruction of an instance.
.SH "MORE INFORMATION"
.IX Header "MORE INFORMATION"
The perltie section contains an example of tying handles.
.SH COMPATIBILITY
.IX Header "COMPATIBILITY"
This version of Tie::Handle is neither related to nor compatible with
the Tie::Handle (3.0) module available on CPAN. It was due to an
accident that two modules with the same name appeared. The namespace
clash has been cleared in favor of this module that comes with the
perl core in September 2000 and accordingly the version number has
been bumped up to 4.0.