Eulerian/EDW/WebSocket.pm untested

filter: Statementstmt 0.0% 0 / 60 Branchbran 0.0% 0 / 4 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 15 Podpod 0.0% 0 / 9 totaltotal 0.0% 0 / 88 CC 3 SCAR 13.3
CC
3
Cov
0%
join
12.0
new
2.0
_socket
2.0
CRAP 3.8
1 #/usr/bin/env perl
2 ###############################################################################
3 #
4 # @file WebSocket.pm
5 #
6 # @brief API::Eulerian::EDW Request module used to read Websocket messages from remote
7 # peer
8 #
9 # @author Thorillon Xavier:x.thorillon@eulerian.com
10 #
11 # @date 26/11/2021
12 #
13 # @version 1.0
14 #
15 ###############################################################################
16 #
17 # Setup module name.
18 #
19 package API::Eulerian::EDW::WebSocket;
20 #
21 # Enforce compilor rules
22 #
23 use strict; use warnings;
24 #
25 # Import IO::Socket::INET
26 #
27 use IO::Socket::INET();
28 #
29 # Import Protocol::WebSocket::Client
30 #
31 use Protocol::WebSocket::Client;
32 #
33 # Import IO::Select
34 #
35 use IO::Select;
36 #
37 # Import API::Eulerian::EDW::Status
38 #
39 use API::Eulerian::EDW::Status;
40 #
41 # @brief Allocate and initialize a new API::Eulerian::EDW Websocket.
42 #
43 # @param $class - API::Eulerian::EDW::WebSocket class.
44 # @param $host - Remote host.
45 # @param $port - Remote port.
46 #
47 # @return API::Eulerian::EDW WebSocket instance.
48 #
49 sub new
50 {
51 my ( $class, $host, $port ) = @_;
52 return bless( {
53 _HOOK => undef,
54 _SELECT => undef,
55 _RFDS => undef,
56 _SOCKET => IO::Socket::INET->new(
57 PeerAddr => $host, PeerPort => $port,
58 Blocking => 1, Proto => 'tcp'
59 ),
60 }, $class
61 );
62 }
63 #
64 # @brief Get Socket.
65 #
66 # @param $self - API::Eulerian::EDW::WebSocket instance.
67 #
68 # @return Socket.
69 #
70 sub _socket
71 {
72 return shift->{ _SOCKET };
73 }
74 #
75 # @brief Get API::Eulerian::EDW Websocket Remote Host.
76 #
77 # @param $self - API::Eulerian::EDW::WebSocket instance.
78 #
79 # @return Remote Host.
80 #
81 sub host
82 {
83 return shift->socket()->peerhost();
84 }
85 #
86 # @brief Get API::Eulerian::EDW Websocket Remote Port.
87 #
88 # @param $self - API::Eulerian::EDW::WebSocket instance.
89 #
90 # @return Remote Port.
91 #
92 sub port
93 {
94 return shift->socket()->peerport();
95 }
96 #
97 # @brief On write Websocket handler.
98 #
99 # @param $self - WebSocket.
100 # @param $data - Data to be writen
101 #
102 # @return Writen Size.
103 #
104 sub _on_write
105 {
106 my ( $peer, $buf ) = @_;
107 $peer->{ _WS }->{ _SOCKET }->syswrite( $buf );
108 }
109 #
110 # @brief On read Websocket handler.
111 #
112 # @param $self - Websocket.
113 #
114 # @return
115 #
116 sub _on_read
117 {
118 my ( $peer, $buf ) = @_;
119 my $ws = $peer->{ _WS };
120 $ws->{ _HOOK }( $ws, $buf );
121 }
122 #
123 # @brief On error Websocket handler.
124 #
125 # @param $self - Websocket.
126 #
127 # @return
128 #
129 sub _on_error
130 {
131 my ( $self, $error ) = @_;
132 print STDERR "Websocket error : $error\n";
133 }
134 #
135 # @brief On connect Websocket handler.
136 #
137 # @param $self - Websocket.
138 #
139 # @return
140 #
141 sub _on_connect
142 {
143 }
144 #
145 # @brief Join given url in Websocket mode, call hook for each received buffer.
146 #
147 # @param $self - API::Eulerian::EDW::WebSocket instance.
148 # @param $url - Remote url.
149 # @param $hooks - User specific hook callback.
150 #
151 # @return API::Eulerian::EDW::Status instance.
152 #
153 sub join
154 {
155 my ( $self, $url, $hook ) = @_;
156 my $status = API::Eulerian::EDW::Status->new();
157 my $socket = $self->_socket();
158 my $bufsize = 4 * 1024 * 1024;
159 my $offset = 0;
160 my $buf = '';
161 my $read;
162 my $rfds;
163 my $peer;
164  
165 # Create a Websocket
166 $peer = Protocol::WebSocket::Client->new(
167 url => $url,
168 max_payload_size => $bufsize
169 );
170  
171 # Setup Websocket hooks
172 $peer->on( write => \&API::Eulerian::EDW::WebSocket::_on_write );
173 $peer->on( read => \&API::Eulerian::EDW::WebSocket::_on_read );
174 $peer->on( error => \&API::Eulerian::EDW::WebSocket::_on_error );
175 $peer->on( connect => \&API::Eulerian::EDW::WebSocket::_on_connect );
176  
177 # Save back refs
178 $self->{ _HOOK } = $hook;
179 $peer->{ _WS } = $self;
180  
181 # Connect on remote host
182 $peer->connect;
183  
184 # If connected
185 if( defined( $socket->connected ) ) {
186 for(; defined( $socket ); ) {
187 $read = $socket->sysread( $buf, $bufsize, $offset );
188 if( $read > 0 ) {
189 $peer->read( $buf );
190 } else {
191 close( $socket );
192 undef( $socket );
193 last;
194 }
195 }
196 }
197  
198 # Disconnect from remote host
199 $peer->disconnect;
200  
201 return $status;
202 }
203 #
204 # End up module properly
205 #
206 1;
207  
208 __END__