Net::Async::WebSocket::Client - connect to a WebSocket server using IO::Async
Net::Async::WebSocket::Client
IO::Async
use IO::Async::Loop; use Net::Async::WebSocket::Client; my $client = Net::Async::WebSocket::Client->new( on_text_frame => sub { my ( $self, $frame ) = @_; print $frame; }, ); my $loop = IO::Async::Loop->new; $loop->add( $client ); $client->connect( url => "ws://$HOST:$PORT/", )->then( sub { $client->send_text_frame( "Hello, world!\n" ); })->get; $loop->run;
This subclass of Net::Async::WebSocket::Protocol connects to a WebSocket server to establish a WebSocket connection for passing frames.
The following methods documented with a trailing call to ->get return Future instances.
->get
$self->connect( %params )->get
Connect to a WebSocket server. Takes the following named parameters:
URL to provide to WebSocket handshake. This is also used to infer the host and service name (port number) if not otherwise supplied.
Optional. If provided, gives the Protocol::WebSocket::Request instance used for performing the handshake.
The returned Future returns the client instance itself, making it useful in chaining constructors.
$self->connect( %params )
When not returning a Future, the following additional parameters provide continuations:
Future
CODE reference to invoke when the handshaking is complete.
$client->connect_handle( $handle, %params )->get
Sets the read and write handles to the IO reference given, then performs the initial handshake using the parameters given. These are as for connect.
connect
Paul Evans <leonerd@leonerd.org.uk>
To install Net::Async::WebSocket, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Async::WebSocket
CPAN shell
perl -MCPAN -e shell install Net::Async::WebSocket
For more information on module installation, please visit the detailed CPAN module installation guide.