File size: 3,718 Bytes
fd49381 |
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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 |
###############################################################################
#
# This Perl module provides a "packet socket" of the kind that
# XML-RPC For C/C++ uses for its "packet stream" variation on XML-RPC.
#
# This module does not use the XML-RPC For C/C++ libraries. It is
# pure Perl and layers on top of IO::Socket.
#
# By Bryan Henderson, San Jose CA 08.03.12.
#
# Contributed to the public domain by author.
#
###############################################################################
package IO::PacketSocket;
use strict;
use warnings;
use Exporter;
use Carp;
use vars qw(@ISA $VERSION @EXPORT);
use Errno qw(:POSIX);
use English;
use IO::Socket::INET
$VERSION = 1.00;
@ISA = qw(Exporter IO);
my ($TRUE, $FALSE) = (1,0);
my $ESC = chr(0x1B); # ASCII Escape
my $startDelim = $ESC . 'PKT';
my $endDelim = $ESC . 'END';
my $escapedEsc = $ESC . 'ESC';
sub createObject {
my ($class, %args) = @_;
my $errorRet;
# Description of why we can't create the object. Undefined if
# we haven't given up yet.
my $packetSocket;
$packetSocket = {};
bless ($packetSocket, $class);
if (defined($args{STREAMSOCKET})) {
$packetSocket->{STREAMSOCKET} = $args{STREAMSOCKET};
} else {
$errorRet = "You must specify STREAMSOCKET";
}
$packetSocket->{RECEIVE_BUFFER} = '';
if ($errorRet && !$args{ERROR}) {
carp("Failed to create PacketSocket object. $errorRet");
}
if ($args{ERROR}) {
$ {$args{ERROR}} = $errorRet;
}
if ($args{HANDLE}) {
$ {$args{HANDLE}} = $packetSocket;
}
}
sub new {
my ($class, %args) = @_;
$args{HANDLE} = \my $retval;
$args{ERROR} = undef;
$class->createObject(%args);
return $retval;
}
sub escaped($) {
my ($x) = @_;
#-----------------------------------------------------------------------------
# Return $x, but properly escaped to be inside a packet socket
# packet.
#-----------------------------------------------------------------------------
$x =~ s{$ESC}{$escapedEsc}g;
return $x;
}
sub unescaped($) {
my ($x) = @_;
#-----------------------------------------------------------------------------
# Inverse of escaped()
#-----------------------------------------------------------------------------
$x =~ s{$escapedEsc}{$ESC}g;
return $x;
}
sub send() {
my($this, $payload) = @_;
my $retval;
my $packet = $startDelim . escaped($payload) . $endDelim;
$retval = $this->{STREAMSOCKET}->send($packet);
return $retval;
}
sub havePacket() {
my ($this) = @_;
return ($this->{RECEIVE_BUFFER} =~ m{$endDelim});
}
sub validatePacketStart($) {
my ($packetR) = @_;
my $delim = substr($$packetR, 0, 4);
if ($startDelim !~ m{^$delim}) {
die("Received bytes '$delim' are not in any packet. " .
"Sender is probably not using a packet socket");
}
}
sub recv() {
my ($this, $payloadR) = @_;
my $gotPacket;
my $eof;
my $escapedPacket;
$gotPacket = $FALSE;
$eof = $FALSE;
while (!$gotPacket && !$eof) {
validatePacketStart(\$this->{RECEIVE_BUFFER});
$this->{STREAMSOCKET}->recv(my $buffer, 4096, 0);
if ($buffer eq '') {
$eof = $TRUE;
} else {
$this->{RECEIVE_BUFFER} .= $buffer;
}
validatePacketStart(\$this->{RECEIVE_BUFFER});
if ($this->{RECEIVE_BUFFER} =~
m{^($startDelim)(.*?)($endDelim)(.*)}s) {
($escapedPacket, $this->{RECEIVE_BUFFER}) = ($2, $3);
$gotPacket = $TRUE;
}
}
$$payloadR = $eof ? '' : unescaped($escapedPacket);
}
1;
|