1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
#-*- perl -*-
#
# Copyright (C) 2003,2004,2005,2006 Ken'ichi Fukamachi
# All rights reserved. This program is free software; you can
# redistribute it and/or modify it under the same terms as Perl itself.
#
# $FML: Message.pm,v 1.8 2006/11/12 14:39:14 fukachan Exp $
#
package FML::IPC::Message;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
=head1 NAME
FML::IPC::Message - basic message abstaction for IPC.
=head1 SYNOPSIS
my $msg = new FML::IPC::Message;
=head1 DESCRIPTION
FML::IPC::Message provides basic message abstraction suitable for
message queue library.
=head1 METHODS
=head2 new()
constructor.
=cut
# Descriptions: constructor.
# Arguments: OBJ($self) HASH_REF($args)
# Side Effects: create an object
# Return Value: OBJ
sub new
{
my ($self, $args) = @_;
my ($type) = ref($self) || $self;
my $me = {};
return bless $me, $type;
}
# Descriptions: set value for key.
# Arguments: OBJ($self) STR($key) STR($value)
# Side Effects: none
# Return Value: none
sub set
{
my ($self, $key, $value) = @_;
$self->{ $key } = $value;
}
# Descriptions: get value for key.
# Arguments: OBJ($self) STR($key)
# Side Effects: none
# Return Value: STR
sub get
{
my ($self, $key) = @_;
return $self->{ $key } || '';
}
# Descriptions: dump data into handle $wh.
# Arguments: OBJ($self) HANDLE($wh)
# Side Effects: none
# Return Value: none
sub dump
{
my ($self, $wh) = @_;
my ($k, $v);
while (($k, $v) = each %$self) {
if ($k =~ /\s+/o) {
croak("invalid key: contains space");
}
else {
print $wh "$k\t$v\n";
}
}
}
# Descriptions: restore data from handle $rh.
# Arguments: OBJ($self) HANDLE($rh)
# Side Effects: none
# Return Value: none
sub restore
{
my ($self, $rh) = @_;
my ($k, $v);
my $buf;
LINE:
while ($buf = <$rh>) {
next LINE if $buf =~ /^\s*$/o;
($k, $v) = split(/\s+/, $buf, 2);
$self->set($k, $v) if defined $k && defined $v;
}
}
=head1 CODING STYLE
See C<http://www.fml.org/software/FNF/> on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2003,2004,2005,2006 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
FML::IPC::Message appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
