/ 
Slackware-Slackget-0.17
River stage one • 1 direct dependent • 1 total dependent
/ Slackware::Slackget::Network::Message

NAME

Slackware::Slackget::Network::Message - The response object for Slackware::Slackget::Network class

VERSION

Version 1.0.0

SYNOPSIS

This class is the message object used by the Slackware::Slackget::Network class to return informations from the network connection.

This module is the evolution of the old Slackware::Slackget::Network::Response.

new

the constructor require no argument. But store every given argument in the object (which is a hashref).

my $msg = new Slackware::Slackget::Network::Message ;

new_from_data

This is an alternative constructor to create a Slackware::Slackget::Network::Message with the whole slack-get protocol compatible data structure.

You must provide the following arguments :

* an action id (integer)
* a action (string)
* some data

Here is a little example :

my $msg = Slackware::Slackget::Network::Message->new(
	123456789,
	'search',
	@keywords,
);

create_enveloppe

Create a base enveloppe for the SlackGetProtocol in the raw_data section. This method access directly to the object's data structure.

Be carefull not to use it on an already initialized object. Else all "raw_data" will be lost.

$self = {
	action => 0,
	action_id => 0,
	raw_data => {
			Enveloppe => {
				Action => {
					id => 0 ,
					content => 0,
				},
				Data => {},
			}
		}
};

is_success

true if the operation is a success

is_error

true if the operation is an error

error_msg

return a string containing an error message. Works only if $response->is_error() is true.

have_choice

true if the daemon return a choice

data

return all raw data returned by the remote daemon

action

return (or set) the action of the message (all network messages must have an action).

action_id

return (or set) the action ID of the message (all network messages must have an action id).

AUTHOR

DUPUIS Arnaud, <a.dupuis@infinityperl.org>

BUGS

Please report any bugs or feature requests to bug-Slackware-Slackget@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Slackware-Slackget. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Slackware::Slackget

You can also look for information at:

ACKNOWLEDGEMENTS

Thanks to Bertrand Dupuis (yes my brother) for his contribution to the documentation.

COPYRIGHT & LICENSE

Copyright 2005 DUPUIS Arnaud, All Rights Reserved.

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