Perl x Open Food Facts Hackathon: Paris, France - May 24-25 Learn more

EHUELS / Protocol-Sys-Virt-v11.3.0 / lib / Protocol / Sys / Virt / UNIXSocket.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
—
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

              
####################################################################
#
#     This file was generated using XDR::Parse version v0.3.1,
#        XDR::Gen version 0.0.5 and LibVirt version v11.3.0
#
#      Don't edit this file, use the source template instead
#
#                 ANY CHANGES HERE WILL BE LOST !
#
####################################################################
use v5.14;
use warnings;
package Protocol::Sys::Virt::UNIXSocket v11.3.0;
use parent qw(Exporter);
use Carp qw(croak);
use Log::Any qw($log);
our @EXPORT = qw( socket_path );
sub socket_path {
    my %args = @_;
    my $path = $args{prefix} // '';
    $path .= '/run/libvirt';
    my $driver;
    my $mode = $args{mode} // 'legacy';
    if ($mode eq 'direct' and ($args{hypervisor} // $args{driver})) {
        $path .= '/virt' . ($args{hypervisor} // $args{driver}) . 'd-sock';
    }
    else {
        $path .= '/libvirt-sock';
    }
    if ($args{readonly}) {
        $path .= '-ro';
    }
    return $path;
}
1;
__END__
=head1 NAME
Protocol::Sys::Virt::UNIXSocket - Helper routines for parsing LibVirt
 Unix sockets
=head1 VERSION
v11.3.0
=head1 SYNOPSIS
  use Protocol::Sys::Virt::UNIXSocket; # imports 'socket_path'
  my $path = socket_path();
=head1 DESCRIPTION
Helper functions for LibVirt Unix sockets.
=head1 FUNCTIONS
=head2 socket_path
  my $path = socket_path(type => 'system', mode => 'direct', readonly => 1);
Returns the path name of the socket with the given parameters. The following
parameters may be given:
=over 8
=item * type
=over 8
=item * C<system> (default)
=item * C<user>
=back
=item * mode
=over 8
=item * C<legacy> (default)
=item * C<direct>
In case the C<hypervisor> value is missing, the function
falls back to C<legacy> mode.
=back
=item * readonly
When passed with a non-zero value, returns the name
 of the read-only socket.
=item * prefix
Path to prepend to state directory name holding the sockets.
Eg., C<< prefix => '/var' >> causes sockets paths to be rooted at
C< /var/run/libvirt > instead of C< /run/libvirt >.
=item * hypervisor
Specifies the name of the hypervisor to connect to; uses
the same naming scheme as the protocol part of the URI.
Example values are C<qemu> and C<vbox>.
=item * driver
Alternative name for C<hypervisor>.
=back
=head1 SEE ALSO
L<LibVirt|https://libvirt.org>, L<Sys::Virt>
=head1 LICENSE AND COPYRIGHT
See the LICENSE file in this distribution.