NAME

Net::Clacks::Client - client for CLACKS interprocess messaging

SYNOPSIS

  use Net::Clacks::Client;

DESCRIPTION

This implements the client network protocol for the CLACKS interprocess messaging. This is used a lot in PageCamel projects to let different processes (workers, webgui, PageCamelSVC) communicate with each other

new

Create a new instance.

reconnect

Reconnect to the CLACKS server when something went wrong.

doNetwork

Process incoming and outpoing messages.

ping

Send a PING (keepalive) packet.

disablePing

Temporarly disable auto-disconnects by the server (NOPING command). Useful before doing something with indeterminate length (long running functions and such).

notify

NOTIFY other clients via CLACKS that an event happened.

set

SET a value for a CLACKS variable to other clients.

listen

LISTEN to specific NOTIFY and SET events.

unlisten

Stop listening to specific NOTIFY and SET events.

setMonitormode

Enable/Disable monitor mode. When enabled, the server sends all events it sees as DEBUG events (events LISTENed to also get send the normal way).

getServerinfo

Get server name and version.

getNext

Get the next incoming event in the queue.

setAndStore

Meta-function that both calls set() and store() internally with a single library call. Useful in some circumstances when you both want to remember the variable and also tell everyone interested immediately that it has changed.

DESTROY

Automatically closes the connection.

IMPORTANT NOTE

Please make sure and read the documentations for Net::Clacks as it contains important information pertaining to upgrades and general changes!

AUTHOR

Rene Schickbauer, <cavac@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2008-2019 Rene Schickbauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.