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

EHUELS / Sys-Async-Virt-v0.0.17 / lib / Sys / Async / Virt / Connection / Factory.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

              
####################################################################
#
#     This file was generated using XDR::Parse version v0.3.1
#                   and LibVirt version v11.1.0
#
#      Don't edit this file, use the source template instead
#
#                 ANY CHANGES HERE WILL BE LOST !
#
####################################################################
use v5.26;
use warnings;
use experimental 'signatures';
use Future::AsyncAwait;
package Sys::Async::Virt::Connection::Factory v0.0.17;
use Carp qw(croak);
use Log::Any qw($log);
use Protocol::Sys::Virt::URI; # imports 'parse_url'
our @default_drivers = (
    { transport => '', class => 'Local', host => 0 },
    { transport => 'unix', class => 'Local', host => 0 },
    # { transport => '', class => 'TCP', host => 1 },
    # { transport => 'tls', class => 'TCP' },
    # { transport => 'tcp', class => 'TCP' },
    { transport => 'ext', class => 'Process' },
    { transport => 'ssh', class => 'SSH' },
    );
sub new {
    my ($class, %args) = @_;
    return bless {
        drivers => $args{drivers} // \@default_drivers,
    }, $class;
}
# Not documented in the POD: not a method
sub _cls_name($n) {
    return ($n =~ s/^\+//)
        ? $n : "Sys::Async::Virt::Connection::$n";
}
sub create_connection( $self, $url, %args ) {
    my %components = parse_url( $url );
    my $transport = $components{transport} // '';
    my $host = $components{host} // '';
    for my $driver ($self->{drivers}->@*) {
        if ($transport eq $driver->{transport}) {
            if (defined $driver->{host}) {
                if (($driver->{host} and $host)
                    or (not $driver->{host} and not $host)) {
                    my $c = _cls_name( $driver->{class} );
                    if (not eval "require $c; 1") {
                        die @!;
                    }
                    return $c->new( $url, %args );
                }
            }
            else { # "host" not defined, so not required
                my $c = _cls_name( $driver->{class} );
                if (not eval "require $c; 1") {
                    die @!;
                }
                return $c->new( $url, %args );
            }
        }
    }
    die $log->fatal( "No handler for: $url" );
}
1;
__END__
=head1 NAME
Sys::Async::Virt::Connection::Factory - Class for
 instantiation of connection objects
=head1 VERSION
v0.0.17
=head1 SYNOPSIS
  use v5.26;
  use Future::AsyncAwait;
  use Sys::Async::Virt::Connection::Factory;
  my $factory = Sys::Async::Virt::Connection::Factory->new(
     drivers => [
            { transport => '', class => 'Local', host => 0 },
            { transport => 'unix', class => 'Local', host => 0 },
     ]
  );
  my $conn = $factory->create_connection( 'qemu+unix:///system' );
=head1 DESCRIPTION
This module provides a central entrypoint to instantiate connections to
LibVirt servers for configured means of transport.
=head1 VARIABLES
=head2 @default_drivers
  push @Sys::Async::Virt::Connection::Factory::default_drivers,
    { transport => 'tls', class => 'TCP' };
List of drivers to be used when no drivers have been provided to the
factory's C<new> constructor.
=head1 CONSTRUCTOR
=head2 new
Accepts the following named parameters:
=over 8
=item * drivers
An array mapping URLs to driver classes. Each array entry is a hash with
the following keys:
=over 8
=item * transport
An empty string if no transport is specified; the part after the '+'
in the URL protocol (i.e. C<ssh> in C<qemu+ssh://>).
=item * host
A boolean indicating if a host value is allowed (C<undef>),
prohibited (0) or required (1).
=item * class
The (shortened) name of the driver class: Values I<not> starting with a
C<+>, will have C<Sys::Async::Virt::Connection::> prepended; those which
I<are> starting with a C<+> will have it removed.
E.g. C<Local> will resolve to C<Sys::Async::Virt::Connection::Local> and
C<+YourPackage::Local> resolves to C<YourPackage::Local>.
=back
The default value maps the following transports: C<''>, C<unix>.
=back
=head1 METHODS
=head2 create_connection
  my $conn = $factory->create_connection( $url );
Instantiates the connection driver configured to service the given C<$url>.
=head1 SEE ALSO
L<LibVirt|https://libvirt.org>, L<Sys::Virt>
=head1 LICENSE AND COPYRIGHT
  Copyright (C) 2024 Erik Huelsmann
All rights reserved. This program is free software;
you can redistribute it and/or modify it under the same terms as Perl itself.