/ 
ZMQx-Class-0.005
River stage zero No dependents
/ ZMQx::Class::Socket

NAME

ZMQx::Class::Socket - A ZMQ Socket

VERSION

version 0.005

METHODS

socket

$socket->socket;

Returns the underlying ZMQ::LibZMQ3::Socket socket. You probably won't need to call this method yourself.

When a process containg a socket is forked, a new instance of the socket will be set up for the child process.

$socket->bind( $address );

Bind a socket to an address. Use this for the "server" side, which usually is the more stable part of your infrastructure.

bind will die if it cannot bind.

connect

$socket->connect( $address );

Connect the socket to an address. Use this for the "client" side.

connect will die if it cannot connect.

setsockopt

use ZMQ::Constants qw( ZMQ_LINGER );
$socket->setsockopt( ZMQ_LINGER, 100 );

Set a socket options using a constant. You will need to load the constant from ZMQ::Constants.

getsockopt

use ZMQ::Constants qw( ZMQ_LINGER );
$socket->getsockopt( ZMQ_LINGER );

Get a socket option value using a constant. You will need to load the constant from ZMQ::Constants.

send

my $rv = $socket->send( \@message );
my $rv = $socket->send( \@message, ZMQ_DONTWAIT );
my $rv = $socket->send( $message );

Send a message over the socket.

The message can either be a plain string or an ARRAYREF which will be send as a multipart message (with one message per array element). send will automatically set ZMQ_SENDMORE for multipart messages.

You can pass flags to send. Currently the only flag is ZMQ_DONTWAIT.

send returns the number of bytes send in the last message (TODO this should be changes to the total number of bytes for the whole multipart message), or -1 on error.

receive

my $msg = $socket->receive;
my $msg = $socket->receive('blocking;);

receive will get the next message from the socket, if there is one.

You can use the blocking mode (by passing a true value to receive) to block the process until a message has been received (NOT a wise move if you are connected to a lot of clients! Use AnyEvent in this case)

The message will always be a ARRAYREF containing one element per message part.

Returns undef if no message can be received.

See t/30_anyevent.t for some examples

anyevent_watcher

my $watcher = $socket->anyevent_watcher( sub {
    while (my $msg = $socket->receive) {
        # do something with msg
    }
} );

Set up an AnyEvent watcher that will call the passed sub when a new incoming message is received on the socket.

Note that the $socket object isn't passed to the callback. You can only access the $socket thanks to closures.

Please note that you will have to load AnyEvent in your code!

AUTHOR

Thomas Klausner <domm@plix.at>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Validad AG.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.