File: remctl_set_source_ip.pod

package info (click to toggle)
remctl 3.18-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,612 kB
  • sloc: ansic: 19,504; sh: 5,386; perl: 1,778; java: 740; makefile: 715; xml: 502; python: 430
file content (64 lines) | stat: -rw-r--r-- 1,813 bytes parent folder | download | duplicates (5)
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
=for stopwords
remctl API Allbery const IP IPv4 IPv6 IPv4-only IPv6-only
SPDX-License-Identifier FSFAP

=head1 NAME

remctl_set_source_ip - Set source IP for remctl client connections

=head1 SYNOPSIS

#include <remctl.h>

int B<remctl_set_source_ip>(struct remctl *I<r>, const char *I<source>);

=head1 DESCRIPTION

remctl_set_source_ip() sets the source IP address for subsequent calls to
remctl_open() on the same struct remctl object.  Call this function before
remctl_open() if remctl client connections need to come from a specific
source IP.

The I<source> parameter may be an IPv4 or IPv6 address (assuming the host
supports IPv6).

Be aware that if you set an IPv4 source address and then attempt to
connect to an IPv6 address or IPv6-only host, or if you set an IPv6
address and then attempt to connect to an IPv4 address or IPv4-only host,
you will get a connection failure error from remctl_open().

=head1 RETURN VALUE

remctl_set_source_ip() returns true on success and false on failure.  On
failure, the caller should call remctl_error() to retrieve the error
message.

=head1 COMPATIBILITY

This interface was added in version 3.0.

=head1 AUTHOR

Russ Allbery <eagle@eyrie.org>

=head1 COPYRIGHT AND LICENSE

Copyright 2011, 2014 The Board of Trustees of the Leland Stanford Junior
University

Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved.  This file is offered as-is, without any
warranty.

SPDX-License-Identifier: FSFAP
  
=head1 SEE ALSO

remctl_new(3), remctl_open(3), remctl_error(3)

The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
L<https://www.eyrie.org/~eagle/software/remctl/>.

=cut