blob: 2587cecb44b8f26055460d47907c9248bcbeac5d (
plain)
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
|
#-*- perl -*-
#
# Copyright (C) 2003,2004 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: Queue.pm,v 1.3 2004/01/02 14:42:46 fukachan Exp $
#
package FML::IPC::Queue;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
=head1 NAME
FML::IPC::Queue - basic message queue operation
=head1 SYNOPSIS
my $queue = new FML::IPC::Queue;
my $msg = new UserDefinedMessageObject { .. } # user defined object.
$queue->append($msg);
my $qlist = $queue->list();
for my $m (@$qlist) { $m->print();}
=head1 DESCRIPTION
FML::IPC::Queue provides basic message queue operations such as
appending messages into the queue,
list up queue et.al.
=head1 METHODS
=head2 new()
constructor.
=head2 append($msg)
append user defined message $msg into the message queue.
=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 $queue = [];
my $me = { _queue => $queue };
return bless $me, $type;
}
# Descriptions: append user defined message $msg into the message queue.
# Arguments: OBJ($self) VAR_ARGS($msg)
# Side Effects: update message queue $self->{ _queue }
# Return Value: none
sub append
{
my ($self, $msg) = @_;
my $q = $self->{ _queue };
push(@$q, $msg);
}
# Descriptions: return the queue as ARRAY_REF.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: ARRAY_REF
sub list
{
my ($self) = @_;
return $self->{ _queue };
}
=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 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::Queue appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
