| 1 | ## -*- Mode: CPerl -*- | ||
| 2 | ## | ||
| 3 | ## File: DTA::CAB::Queue::Client.pm | ||
| 4 | ## Author: Bryan Jurish <moocow@cpan.org> | ||
| 5 | ## Description: UNIX-socket based queue: server | ||
| 6 | |||
| 7 | package DTA::CAB::Queue::Client; | ||
| 8 | use DTA::CAB::Socket ':flags'; | ||
| 9 | use DTA::CAB::Socket::UNIX; | ||
| 10 | use DTA::CAB::Utils ':temp', ':files'; | ||
| 11 | use Carp; | ||
| 12 | use strict; | ||
| 13 | |||
| 14 | ##============================================================================== | ||
| 15 | ## Globals | ||
| 16 | ##============================================================================== | ||
| 17 | our @ISA = qw(DTA::CAB::Socket::UNIX); | ||
| 18 | |||
| 19 | ##============================================================================== | ||
| 20 | ## Constructors etc. | ||
| 21 | ##============================================================================== | ||
| 22 | |||
| 23 | ## $qc = DTA::CAB::Queue::Client->new(%args) | ||
| 24 | ## + %$qc, %args: | ||
| 25 | ## ( | ||
| 26 | ## ##-- NEW in DTA::CAB::Queue::Client | ||
| 27 | ## peer => $path, ##-- constructor override sets $qc->{peer} but suppresses auto-open() on new() | ||
| 28 | ## ## | ||
| 29 | ## ##-- INHERITED from DTA::CAB::Socket::UNIX | ||
| 30 | ## #local => $path, ##-- path to local UNIX socket (for server; set to empty string to use a tempfile) | ||
| 31 | ## peer => $path, ##-- path to peer socket (for client) | ||
| 32 | ## listen => $n, ##-- queue size for listen (default=SOMAXCONN) | ||
| 33 | ## unlink => $bool, ##-- if true, server socket will be unlink()ed on DESTROY() (default=true) | ||
| 34 | ## perms => $perms, ##-- file create permissions for server socket (default=0600) | ||
| 35 | ## ## | ||
| 36 | ## ##-- INHERITED from DTA::CAB::Socket | ||
| 37 | ## fh => $sockfh, ##-- an IO::Socket::UNIX object for the socket | ||
| 38 | ## timeout => $secs, ##-- default timeout for select() (default=undef: none) | ||
| 39 | ## logSocket => $level, ##-- log level for full socket I/O trace (default=undef (none)) | ||
| 40 | ## logRequest => $level, ##-- log level for client requests (server only; default=undef (none)) | ||
| 41 | ## ) | ||
| 42 | sub new { | ||
| 43 | my ($that,%args) = @_; | ||
| 44 | my $peer = $args{peer}; | ||
| 45 | delete @args{qw(peer local)}; | ||
| 46 | my $qc = $that->SUPER::new(%args); ##-- no auto-open | ||
| 47 | $qc->{peer} = $peer; | ||
| 48 | return $qc; | ||
| 49 | } | ||
| 50 | |||
| 51 | ##============================================================================== | ||
| 52 | ## Open/Close | ||
| 53 | ## + all INHERITED from CAB::Socket::UNIX, CAB::Socket | ||
| 54 | |||
| 55 | ##============================================================================== | ||
| 56 | ## Socket Communications | ||
| 57 | ## + all INHERITED from CAB::Socket | ||
| 58 | |||
| 59 | ##============================================================================== | ||
| 60 | ## Queue Server Protocol | ||
| 61 | |||
| 62 | ## $qc = $qc->enq($item) | ||
| 63 | sub enq { | ||
| 64 | $_[0]->reopen->put_str('enq')->put($_[1])->close; | ||
| 65 | } | ||
| 66 | |||
| 67 | ## $qc = $qc->enq_str( $str) | ||
| 68 | ## $qc = $qc->enq_str(\$str) | ||
| 69 | sub enq_str { | ||
| 70 | $_[0]->reopen->put_str('enq_str')->put_str(ref($_[1]) ? $_[1] : \$_[1])->close; | ||
| 71 | } | ||
| 72 | |||
| 73 | ## $qc = $qc->enq_ref($ref) | ||
| 74 | sub enq_ref { | ||
| 75 | $_[0]->reopen->put_str('enq_ref')->put_ref(ref($_[1]) ? $_[1] : \$_[1])->close; | ||
| 76 | } | ||
| 77 | |||
| 78 | ## $item = $qc->deq() | ||
| 79 | ## $item = $qc->deq(\$buf) | ||
| 80 | sub deq { | ||
| 81 | my ($flags,$len,$ref) = $_[0]->reopen->put_str('deq')->get(@_[1..$#_]); | ||
| 82 | $_[0]->close; | ||
| 83 | return ( ($flags & $sf_ref) ? $ref : $$ref ); | ||
| 84 | } | ||
| 85 | |||
| 86 | ## \$str = $qc->deq_str() | ||
| 87 | ## \$str = $qc->deq_str( \$str ) | ||
| 88 | sub deq_str { | ||
| 89 | my $ref = $_[0]->reopen->put_str('deq_str')->get(@_[1..$#_]); | ||
| 90 | $_[0]->close; | ||
| 91 | return $ref; | ||
| 92 | } | ||
| 93 | |||
| 94 | ## $ref = $qc->deq_ref() | ||
| 95 | ## $ref = $qc->deq_ref( \$buf ) | ||
| 96 | sub deq_ref { | ||
| 97 | my $ref = $_[0]->reopen->put_str('deq_ref')->get(@_[1..$#_]); | ||
| 98 | $_[0]->close; | ||
| 99 | return $ref; | ||
| 100 | } | ||
| 101 | |||
| 102 | |||
| 103 | ## $status = $qc->status() | ||
| 104 | ## + get server status | ||
| 105 | sub status { | ||
| 106 | my $qc = shift; | ||
| 107 | my $ref = $qc->reopen->put_str('status')->get; | ||
| 108 | $qc->close(); | ||
| 109 | return $$ref; | ||
| 110 | } | ||
| 111 | |||
| 112 | ## $size = $qc->size() | ||
| 113 | ## + get current length of server queue | ||
| 114 | sub size { | ||
| 115 | my $qc = shift; | ||
| 116 | my $ref = $qc->reopen->put_str('size')->get; | ||
| 117 | $qc->close(); | ||
| 118 | return $$ref; | ||
| 119 | } | ||
| 120 | |||
| 121 | ## undef = $qc->clear() | ||
| 122 | ## + clear the server queue | ||
| 123 | sub clear { | ||
| 124 | $_[0]->reopen->put_str('clear')->close; | ||
| 125 | } | ||
| 126 | |||
| 127 | ## undef = $qc->addcounts($ntok,$nchr) | ||
| 128 | sub addcounts { | ||
| 129 | $_[0]->reopen->put_str('addcounts')->put_str(pack('NN',@_[1,2]))->close; | ||
| 130 | } | ||
| 131 | |||
| 132 | ## undef = $qc->addblock(\%blk) | ||
| 133 | sub addblock { | ||
| 134 | $_[0]->reopen->put_str('addblock')->put_ref($_[1])->close; | ||
| 135 | } | ||
| 136 | |||
| 137 | 1; | ||
| 138 | |||
| 139 | __END__ |