Mark Overmeer > IOMux-0.12 > IOMux::File::Write

Download:
IOMux-0.12.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.12   Source  

NAME ^

IOMux::File::Write - write to file

INHERITANCE ^

 IOMux::File::Write
   is a IOMux::Handler::Write
   is a IOMux::Handler

SYNOPSIS ^

  my $mux = IOMux::Select->new;  # or ::Poll

  use IOMux::Open '>';
  my $file = $mux->open('>', $filename);

  use IOMux::File::Write;
  my $file = IOMux::File::Write->new
    (file => $filename, mode => '>>');
  $mux->add($file);

  $file->write($text);
  $file->print($text);

  write $file $text;
  print $file $text;

DESCRIPTION ^

Open a file to be written.

METHODS ^

Constructors

IOMux::File::Write->new(OPTIONS)
 -Option    --Defined in     --Default
  append                       <false>
  create                       <true>
  exclusive                    <false>
  fh          IOMux::Handler   <required>
  file                         <required>
  mode                         '>'
  modeflags                    <undef>
  name        IOMux::Handler   '$mode$file'
  write_size  IOMux::Handler::Write  4096
append => BOOLEAN
create => BOOLEAN
exclusive => BOOLEAN
fh => FILEHANDLE
file => FILENAME|HANDLE

The file to be managed, either provided as FILENAME or as HANDLE. When a HANDLE is passed, most other options will be ignored. The HANDLE must be in non-blocking mode already and opened for writing (only).

mode => '>'|'>>'

The &gt;&gt; is short for normal open plus the append option set.

modeflags => INTEGER

When defined, the mode, exclusive, create and append options are not used, but your value is taken. Use constants defined by Fcntl. Do not forget to include O_NONBLOCK.

name => STRING
write_size => INTEGER
IOMux::File::Write->open(MODE, FILE, OPTIONS)

Accessors

$obj->fh See "Accessors" in IOMux::Handler
$obj->fileno See "Accessors" in IOMux::Handler
$obj->mode

The bits of the open mode.

$obj->mux See "Accessors" in IOMux::Handler
$obj->name See "Accessors" in IOMux::Handler
$obj->usesSSL See "Accessors" in IOMux::Handler
$obj->writeSize([INTEGER]) See "Accessors" in IOMux::Handler::Write

User interface

Connection

$obj->close([CALLBACK]) See "Connection" in IOMux::Handler
$obj->timeout([TIMEOUT]) See "Connection" in IOMux::Handler

Writing

$obj->print(STRING|SCALAR|LIST|ARRAY) See "Writing" in IOMux::Handler::Write
$obj->printf(FORMAT, PARAMS) See "Writing" in IOMux::Handler::Write
$obj->say(STRING|SCALAR|LIST|ARRAY) See "Writing" in IOMux::Handler::Write
$obj->write(SCALAR, [MORE]) See "Writing" in IOMux::Handler::Write

Multiplexer

Connection

$obj->mux_init(MUX, [HANDLER]) See "Connection" in IOMux::Handler
$obj->mux_remove See "Connection" in IOMux::Handler
$obj->mux_timeout See "Connection" in IOMux::Handler

Reading

$obj->mux_except_flagged(FILENO) See "Reading" in IOMux::Handler
$obj->mux_read_flagged(FILENO) See "Reading" in IOMux::Handler

Writing

$obj->mux_outbuffer_empty See "Writing" in IOMux::Handler::Write
$obj->mux_output_waiting See "Writing" in IOMux::Handler::Write
$obj->mux_write_flagged(FILENO) See "Writing" in IOMux::Handler

Service

Helpers

$obj->extractSocket(HASH)
IOMux::File::Write->extractSocket(HASH) See "Helpers" in IOMux::Handler
$obj->fdset(STATE, READ, WRITE, ERROR) See "Helpers" in IOMux::Handler
$obj->show See "Helpers" in IOMux::Handler

SEE ALSO ^

This module is part of IOMux distribution version 0.12, built on January 27, 2011. Website: http://perl.overmeer.net/ All modules in this suite: "Any::Daemon", "IOMux", and "IOMux::HTTP".

Please post questions or ideas to perl@overmeer.net

LICENSE ^

Copyrights 2011 by Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: