Manual Reference Pages - NET::NSCA::CLIENT::DATAPACKET (3)
Net::NSCA::Client::DataPacket - Implements data packet for the NSCA protocol
This documentation refers to version 0.009002
# Create a packet from scratch
my $packet = Net::NSCA::Client::DataPacket->new(
hostname => www.example.net,
service_description => Apache,
service_message => OK - Apache running,
service_status => $Net::NSCA::Client::STATUS_OK,
unix_timestamp => $iv_timestamp,
# Create a packet recieved from over the network
my $recieved_packet = Net::NSCA::Client::DataPacket->new(
raw_packet => $recieved_data,
Represents the data packet used in the NSCA protocol.
This is fully object-oriented, and as such before any method can be used, the
constructor needs to be called to create an object to work with.
This will construct a new object.
%attributes is a HASH where the keys are attributes (specified in the
$attributes is a HASHREF where the keys are attributes (specified in the
$packet_string is a string of the data packet in the network form.
# Set an attribute
# Get an attribute
my $value = $object->attribute_name;
This is the host name of the host as listed in Nagios that the service
This is the version of the packet to be sent. A few different NSCA servers use
slightly different version numbers, but the rest of the packet is the same.
If not specified, this will default to 3.
This is the raw packet to send over the network. Providing this packet to
the constructor will automatically populate all other attributes and so
they are <B>notB> required if this attribute is provided.
This is the service description as listed in Nagios of the service that this
report will be listed under.
This is the message that will be given to Nagios.
This is the status of the service that will be given to Nagios. It is
recommended to use one of the $STATUS_ constants provided by
This specifies the configuration of the remote NSCA server. See
Net::NSCA::Client::ServerConfig for details
about using this. Typically this does not need to be specified unless the
NSCA server was compiled with customizations.
This is a UNIX timestamp, which is an integer specifying the number of
non-leap seconds since the UNIX epoch. This will default to the current UNIX
This methods returns the string representation of the data packet. This string
representation is what will be sent over the network.
Douglas Christopher Wilson, <doug at somethingdoug.com>
BUGS AND LIMITATIONS
Please report any bugs or feature requests to bug-net-nsca-client at rt.cpan.org,
or through the web interface at
I will be notified, and then youll automatically be notified of progress on
your bug as I make changes.
I highly encourage the submission of bugs and enhancements to my modules.
LICENSE AND COPYRIGHT
Copyright 2009 Douglas Christopher Wilson.
This program is free software; you can redistribute it and/or
modify it under the terms of either:
the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
the Artistic License version 2.0.
|perl v5.20.3 ||NET::NSCA::CLIENT::DATAPACKET (3) ||2016-04-04 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.