data/PVE/IPCC.pm

   1 package PVE::IPCC;
   2
   3 use 5.010001;
   4 use strict;
   5 use warnings;
   6
   7 require Exporter;
   8
   9 our @ISA = qw(Exporter);
  10
  11 # Items to export into callers namespace by default. Note: do not export
  12 # names by default without a very good reason. Use EXPORT_OK instead.
  13 # Do not simply export all your public functions/methods/constants.
  14
  15 # This allows declaration       use PVE::IPCC ':all';
  16 # If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
  17 # will save memory.
  18 our %EXPORT_TAGS = ( 'all' => [ qw(
  19
  20 ) ] );
  21
  22 our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
  23
  24 our @EXPORT = qw(
  25
  26 );
  27
  28 our $VERSION = '1.0';
  29
  30 require XSLoader;
  31 XSLoader::load('PVE::IPCC', $VERSION);
  32
  33 # Preloaded methods go here.
  34
  35 1;
  36 __END__
  37
  38 =head1 NAME
  39
  40 PVE::IPCC - Perl extension to access the PVE IPC Server
  41
  42 =head1 SYNOPSIS
  43
  44   use PVE::IPCC;
  45
  46   my $res = PVE::IPCC::ipcc_send_rec(1, "hello");
  47
  48   my $res = PVE::IPCC::sendfd($socketfd, $fd, $opt_data);
  49
  50 =head1 DESCRIPTION
  51
  52 Send/receive RAW data packets from the PVE IPC Server.
  53
  54 Pass file descriptor over unix domain sockets (used to pass
  55 file destriptors to qemu fdset). This is use in PVE::QMPClient.
  56
  57 =head2 EXPORT
  58
  59 None by default.
  60
  61 =head1 AUTHOR
  62
  63 Dietmar Maurer, E<lt>dietmar@proxmox.com<gt>
  64
  65 =cut