GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Client(3) User Contributed Perl Documentation OpenXPKI::Client(3)

OpenXPKI::Client - OpenXPKI Client base library

This document describes OpenXPKI::Client version 0.0.1

    use OpenXPKI::Client;
    my $client = OpenXPKI::Client->new(
        {
             SOCKETFILE => './foo.socket',
        });

    # create new session
    $client->init_session();

OpenXPKI::Client is a base class for client communication with an OpenXPKI server daemon.

See perldoc Class::Std.

See perldoc Class::Std.

Expects a hash reference as first argument. Serializes the argument and sends it to the OpenXPKI server. Throws an exception if the connection is not in communication state 'can_send'.

Reads an answer from the OpenXPKI server, deserializes the message and returns the corresponding data structure. Throws an exception if the connection is not in communication state 'can_receive'.

Get internal communication state. Returns 'can_send' if the next action should be a talk() call. Returns 'can_receive' if the next action should be a collect() call.

Send a service message. The first argument must be a string identifying the service command to send. The (optional) second argument is a hash reference containing the arguments to be sent along with the service message. The caller must assure that this argument is properly specified.

Send a service command message. The first argument must be a string identifying the command to send. The (optional) second argument is a hash reference containing the arguments to be sent along with the command message.

Send a service message, reads the response and returns it. See send_service_msg.

Send a service command message, reads the response and returns it. See send_command_msg.

Initialize session. If the named argument SESSION_ID exists, this session is re-opened. If it can not be loaded, and expcetion is thrown. If you don't pass a session id, a new session is created. If you want to create a new session if the existing one is no longer available, pass NEW_ON_FAIL with a true value as extra argument.

Returns the first server response (see collect()).

Assign a new session id to the existing session. The old session id is deleted. Returns the new session id.

Returns current session ID (or undef if no session is active).

Set socket read timeout (seconds, default: 30).

Closes the socket connection to the server.

returns true on a normal established connection. Returns false if the connection is missing or something goes wrong during the check.

returns true if a connection is available and the user has finished authentication (i.e. PING returns 'SERVICE_READY').

OpenXPKI::Client requires no configuration files or environment variables.

Requires an OpenXPKI perl core module installation.

None reported.

No bugs have been reported.

Please report any bugs or feature requests to the OpenXPKI mailing list or its project home page http://www.openxpki.org/.

Martin Bartosch "<m.bartosch@cynops.de>"

Written 2006 by Martin Bartosch for the OpenXPKI project Copyright (C) 2006 by The OpenXPKI Project

See the LICENSE file for license details.

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.