GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  IO::ATOMICFILE (3)

.ds Aq ’

NAME

IO::AtomicFile - write a file which is updated atomically

CONTENTS

SYNOPSIS



    use IO::AtomicFile;

    ### Write a temp file, and have it install itself when closed:
    my $FH = IO::AtomicFile->open("bar.dat", "w");
    print $FH "Hello!\n";
    $FH->close || die "couldnt install atomic file: $!";   

    ### Write a temp file, but delete it before it gets installed:
    my $FH = IO::AtomicFile->open("bar.dat", "w");
    print $FH "Hello!\n";
    $FH->delete;

    ### Write a temp file, but neither install it nor delete it:
    my $FH = IO::AtomicFile->open("bar.dat", "w");
    print $FH "Hello!\n";
    $FH->detach;



DESCRIPTION

This module is intended for people who need to update files reliably in the face of unexpected program termination.

For example, you generally don’t want to be halfway in the middle of writing /etc/passwd and have your program terminate! Even the act of writing a single scalar to a filehandle is not atomic.

But this module gives you true atomic updates, via rename(). When you open a file /foo/bar.dat via this module, you are actually opening a temporary file /foo/bar.dat..TMP, and writing your output there. The act of closing this file (either explicitly via close(), or implicitly via the destruction of the object) will cause rename() to be called... therefore, from the point of view of the outside world, the file’s contents are updated in a single time quantum.

To ensure that problems do not go undetected, the close method done by the destructor will raise a fatal exception if the rename() fails. The explicit close() just returns undef.

You can also decide at any point to trash the file you’ve been building.

AUTHOR

    Primary Maintainer

Dianne Skoll (dfs@roaringpenguin.com).

    Original Author

Eryq (eryq@zeegee.com). President, ZeeGee Software Inc (http://www.zeegee.com).

REVISION

$Revision: 1.2 $
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 IO::ATOMICFILE (3) 2015-04-22

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.