|
|
|
|
.\"
|
|
|
|
|
.\" Copyright 2010 by Ben Greear <greearb@candelatech.com>
|
|
|
|
|
.\"
|
|
|
|
|
.\" Permission to use, copy, modify, and distribute this
|
|
|
|
|
.\" software and its documentation for any purpose and without
|
|
|
|
|
.\" fee is hereby granted, provided that the above copyright
|
|
|
|
|
.\" notice appear in all copies and that both that copyright
|
|
|
|
|
.\" notice and this permission notice appear in supporting
|
|
|
|
|
.\" documentation, and that the name of M.I.T. not be used in
|
|
|
|
|
.\" advertising or publicity pertaining to distribution of the
|
|
|
|
|
.\" software without specific, written prior permission.
|
|
|
|
|
.\" M.I.T. makes no representations about the suitability of
|
|
|
|
|
.\" this software for any purpose. It is provided "as is"
|
|
|
|
|
.\" without express or implied warranty.
|
|
|
|
|
.\"
|
|
|
|
|
.\" SPDX-License-Identifier: MIT
|
|
|
|
|
.\"
|
|
|
|
|
.TH ARES_SET_LOCAL_DEV 3 "30 June 2010"
|
|
|
|
|
.SH NAME
|
|
|
|
|
ares_set_local_dev \- Bind to a specific network device when creating sockets.
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <ares.h>
|
|
|
|
|
|
`ares_channel` -> `ares_channel_t *`: don't bury the pointer (#595)
`ares_channel` is defined as `typedef struct ares_channeldata *ares_channel;`. The problem with this, is it embeds the pointer into the typedef, which means an `ares_channel` can never be declared as `const` as if you write `const ares_channel channel`, that expands to `struct ares_channeldata * const ares_channel` and not `const struct ares_channeldata *channel`.
We will now typedef `ares_channel_t` as `typedef struct ares_channeldata ares_channel_t;`, so if you write `const ares_channel_t *channel`, it properly expands to `const struct ares_channeldata *channel`.
We are maintaining the old typedef for API compatibility with existing integrations, and due to typedef expansion this should not even cause any compiler warnings for existing code. There are no ABI implications with this change. I could be convinced to keep existing public functions as `ares_channel` if a sufficient argument exists, but internally we really need make this change for modern best practices.
This change will allow us to internally use `const ares_channel_t *` where appropriate. Whether or not we decide to change any public interfaces to use `const` may require further discussion on if there might be ABI implications (I don't think so, but I'm also not 100% sure what a compiler internally does with `const` when emitting machine code ... I think more likely ABI implications would occur going the opposite direction).
FYI, This PR was done via a combination of sed and clang-format, the only manual code change was the addition of the new typedef, and a couple doc fixes :)
Fix By: Brad House (@bradh352)
1 year ago
|
|
|
void ares_set_local_dev(ares_channel_t *\fIchannel\fP, const char* \fIlocal_dev_name\fP)
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The \fBares_set_local_dev\fP function causes all future sockets
|
|
|
|
|
to be bound to this device with SO_BINDTODEVICE. This forces communications
|
|
|
|
|
to go over a certain interface, which can be useful on multi-homed machines.
|
|
|
|
|
This option is only supported on Linux, and root privileges are required
|
|
|
|
|
for the option to work. If SO_BINDTODEVICE is not supported or the
|
|
|
|
|
setsocktop call fails (probably because of permissions), the error is
|
|
|
|
|
silently ignored.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR ares_set_local_ip4 (3)
|
|
|
|
|
.BR ares_set_local_ip6 (3)
|
|
|
|
|
.SH NOTES
|
|
|
|
|
This function was added in c-ares 1.7.4
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
Ben Greear
|
