FTN::JAM - A Perl extension for handleing JAM messagebases.
Version 0.30
This module can be used for operations related to JAM messagebases, including the following: creating or removing a messagebase, listing the contents of a messagebase, adding a message to a messagebase, reading a message in a messagebase, changing a message in a messagebase, or finding a user in a messagebase.
Here is an example of how it can being used:
use FTN::JAM; my $mb = $ARGV[0]; my $basemsgnum = $ARGV[1]; my $handle = FTN::JAM::CreateMB($mb,$basemsgnum); FTN::JAM::CloseMB($handle); ...
The following functions are available in the module: OpenMB, CreateMB, CloseMB, RemoveMB, LockMB, UnlockMB, ReadMBHeader, WriteMBHeader, GetMBSize, ReadMessage, ChangeMessage, AddMessage, Crc32, FindUser, GetLastRead, SetLastRead, TimeToLocal, and LocalToTime.
The global variable $Errnum is used for returning error numbers from functions and can be accessed as $FTN::JAM::Errnum. It defaults to undefined.
Syntax: $handle = FTN::JAM::OpenMB($jampath)
Syntax: $handle = FTN::JAM::CreateMB($jampath,$basemsg)
Syntax: FTN::JAM::CloseMB($handle)
Syntax: FTN::JAM::RemoveMB($jampath)
Syntax: $success = FTN::JAM::LockMB($handle,$timeout)
Syntax: FTN::JAM::UnlockMB($handle)
Syntax: $success = FTN::JAM::ReadMBHeader($handle,\%header)
Syntax: $success = FTN::JAM::WriteMBHeader($handle,\%header)
Syntax: $success = FTN::JAM::GetMBSize($handle,\$num)
Syntax: $success = FTN::JAM::ReadMessage($handle,$msgnum,\%header,\@subfields,\$text)
Syntax: $success = FTN::JAM::ChangeMessage($handle,$msgnum,\%header)
Syntax: $success = FTN::JAM::AddMessage($handle,\%header,\@subfields,\$text)
Syntax: $crc32 = FTN::JAM::Crc32($data)
Syntax: $msgnum = FTN::JAM::FindUser($handle,$usercrc,$start)
Syntax: $success = FTN::JAM::GetLastRead($handle,$usernum,\%lastread)
Syntax: $success = FTN::JAM::SetLastRead($handle,$usernum,/%lastread)
Syntax $local = FTN::JAM::TimeToLocal($time)
Syntax $time = FTN::JAM::LocalToTime($local)
Robert James Clay, <jame at rocasa.us>
<jame at rocasa.us>
Please report any bugs or feature requests to bug-ftn-jam at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ftn-jam. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-ftn-jam at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc FTN::JAM
You can also look for information at:
FTN::JAM Home Page
http://ftnpl.sourceforge.net/ftnpljam.html
Browse the FTN::JAM GIT repository at SourceForge
http://sourceforge.net/p/ftnpl/ftn-jam/code
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=ftn-jam
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/ftn-jam
CPAN Ratings
http://cpanratings.perl.org/d/ftn-jam
Search CPAN
http://search.cpan.org/dist/ftn-jam
Originally based on the public domain Perl::JAM module by Johan Billing, which can be found at https://bitbucket.org/johanbilling/jampm/overview.
L<FTN::JAM>, L<FTN::JAM::Examples>
Copyright 2010-2012 Robert James Clay, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install FTN::JAM, copy and paste the appropriate command in to your terminal.
cpanm
cpanm FTN::JAM
CPAN shell
perl -MCPAN -e shell install FTN::JAM
For more information on module installation, please visit the detailed CPAN module installation guide.