.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Firefox::Marionette::Proxy 3pm"
.TH Firefox::Marionette::Proxy 3pm "2023-12-22" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Firefox::Marionette::Proxy \- Represents a Proxy used by Firefox Capabilities using the Marionette protocol
.SH "VERSION"
.IX Header "VERSION"
Version 1.35
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Firefox::Marionette();
\&    use v5.10;
\&
\&    my $proxy = Firefox::Marionette::Proxy\->new( pac => \*(Aqhttp://gateway.example.com/\*(Aq );
\&    my $firefox = Firefox::Marionette\->new( capabilities => Firefox::Marionette::Capabilities\->new( proxy => $proxy ) );
\&    foreach my $address ($firefox\->capabilities\->proxy()\->none()) {
\&        say "Browser will ignore the proxy for $address";
\&    }
\&
\&    # OR 
\&
\&    my $proxy = Firefox::Marionette::Proxy\->new( host => \*(Aqsquid.example.com:3128\*(Aq );
\&    my $firefox = Firefox::Marionette\->new( capabilities => Firefox::Marionette::Capabilities\->new( proxy => $proxy ) );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module handles the implementation of a Proxy in Firefox Capabilities using the Marionette protocol
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.SS "new"
.IX Subsection "new"
accepts a hash as a parameter.  Allowed keys are below;
.IP "\(bu" 4
type \- indicates the type of proxy configuration.  Must be one of 'pac', 'direct', 'autodetect', 'system', or 'manual'.
.IP "\(bu" 4
pac \- defines the \s-1URI\s0 for a proxy auto-config file if the type is equal to 'pac'.
.IP "\(bu" 4
host \- defines the host for \s-1FTP, HTTP,\s0 and \s-1HTTPS\s0 traffic and sets the type to 'manual'.
.IP "\(bu" 4
http \- defines the proxy host for \s-1HTTP\s0 traffic when the type is 'manual'.
.IP "\(bu" 4
https \- defines the proxy host for encrypted \s-1TLS\s0 traffic when the type is 'manual'.
.IP "\(bu" 4
none \- lists the addresses for which the proxy should be bypassed when the type is 'manual'.  This may be a list of domains, IPv4 addresses, or IPv6 addresses.
.IP "\(bu" 4
socks \- defines the proxy host for a \s-1SOCKS\s0 proxy traffic when the type is 'manual'.
.IP "\(bu" 4
socks_version \- defines the \s-1SOCKS\s0 proxy version when the type is 'manual'.  It must be any integer between 0 and 255 inclusive, but it defaults to '5'.
.PP
This method returns a new proxy object.
.SS "type"
.IX Subsection "type"
returns the type of proxy configuration.  Must be one of 'pac', 'direct', 'autodetect', 'system', or 'manual'.
.SS "pac"
.IX Subsection "pac"
returns the \s-1URI\s0 for a proxy auto-config file if the type is equal to 'pac'.
.SS "http"
.IX Subsection "http"
returns the proxy host for \s-1HTTP\s0 traffic when the type is 'manual'.
.SS "https"
.IX Subsection "https"
returns the proxy host for encrypted \s-1TLS\s0 traffic when the type is 'manual'.
.SS "none"
.IX Subsection "none"
returns a list of the addresses for which the proxy should be bypassed when the type is 'manual'.  This may be a list of domains, IPv4 addresses, or IPv6 addresses.
.SS "socks"
.IX Subsection "socks"
returns the proxy host for a \s-1SOCKS\s0 proxy traffic when the type is 'manual'.
.SS "socks_version"
.IX Subsection "socks_version"
returns the \s-1SOCKS\s0 proxy version when the type is 'manual'.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
None.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Firefox::Marionette::Proxy requires no configuration files or environment variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
None.
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
To report a bug, or view the current list of bugs, please visit <https://github.com/david\-dick/firefox\-marionette/issues>
.SH "AUTHOR"
.IX Header "AUTHOR"
David Dick  \f(CW\*(C`<ddick@cpan.org>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2023, David Dick \f(CW\*(C`<ddick@cpan.org>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See \*(L"perlartistic\*(R" in perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE 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 \*(L"AS IS\*(R" 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.\s0
.PP
\&\s-1IN 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\s0 (\s-1INCLUDING 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\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0