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


Manual Reference Pages  -  NET::NSCA::CLIENT::CONNECTION::TLS (3)

.ds Aq ’

NAME

Net::NSCA::Client::Connection::TLS - Represents the transport layer security on a connection.

CONTENTS

VERSION

This documentation refers to version 0.009002

SYNOPSIS



  use Net::NSCA::Client::Connection::TLS;

  # Create a new connection TLS
  my $tls = Net::NSCA::Client::Connection::TLS->new(
    encryption_type => xor,
    password        => $my_secret_password,
  );

  # Encrypt a packet
  my $encrypted_packet = $tls->encrypt(
    byte_stream => $data_packet,
    iv          => $iv_salt,
  );



DESCRIPTION

Represents a connection between the NSCA client and server.

CONSTRUCTOR

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.

    new

This will construct a new object.
new(%attributes) %attributes is a HASH where the keys are attributes (specified in the ATTRIBUTES section).
new($attributes) $attributes is a HASHREF where the keys are attributes (specified in the ATTRIBUTES section).

ATTRIBUTES



  # Set an attribute
  $object->attribute_name($new_value);

  # Get an attribute
  my $value = $object->attribute_name;



    encryption_type

This is the type of encryption for this transport layer security object. This will default to xor.

    password

This is the password to use for the encryption.

METHODS

    encrypt

This will encrypt a byte stream according to the attributes of the object. This method takes a HASH of arguments with the following keys:

byte_stream

<B>RequiredB>

This is the byte stream to encrypt.

iv

<B>RequiredB>

This is the initialization vector to use when encrypting the byte stream.

CONSTANTS

<B>TODO: Write thisB>

DEPENDENCIES

o Moose 0.89
o MooseX::StrictConstructor 0.08
o Net::NSCA::Client::Library
o namespace::clean 0.04

AUTHOR

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 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-NSCA-Client>. I will be notified, and then you’ll 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:
o the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or
o the Artistic License version 2.0.

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


perl v5.20.3 NET::NSCA::CLIENT::CONNECTION::TLS (3) 2016-04-04

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