132 lines
4.2 KiB
C
132 lines
4.2 KiB
C
|
/***************************************************************************
|
||
|
|
* libancillary - black magic on Unix domain sockets
|
||
|
|
* (C) Nicolas George
|
||
|
|
* ancillary.c - public header
|
||
|
|
***************************************************************************/
|
||
|
|
|
||
|
|
/*
|
||
|
|
* Redistribution and use in source and binary forms, with or without
|
||
|
|
* modification, are permitted provided that the following conditions are met:
|
||
|
|
*
|
||
|
|
* 1. Redistributions of source code must retain the above copyright notice,
|
||
|
|
* this list of conditions and the following disclaimer.
|
||
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
||
|
|
* notice, this list of conditions and the following disclaimer in the
|
||
|
|
* documentation and/or other materials provided with the distribution.
|
||
|
|
* 3. The name of the author may not be used to endorse or promote products
|
||
|
|
* derived from this software without specific prior written permission.
|
||
|
|
*
|
||
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
|
||
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||
|
|
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
|
||
|
|
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
||
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
|
||
|
|
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
||
|
|
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||
|
|
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||
|
|
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef ANCILLARY_H__
|
||
|
|
#define ANCILLARY_H__
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/***************************************************************************
|
||
|
|
* Start of the readable part.
|
||
|
|
***************************************************************************/
|
||
|
|
|
||
|
|
#define ANCIL_MAX_N_FDS 960
|
||
|
|
/*
|
||
|
|
* Maximum number of fds that can be sent or received using the "esay"
|
||
|
|
* functions; this is so that all can fit in one page.
|
||
|
|
*/
|
||
|
|
|
||
|
|
extern int
|
||
|
|
ancil_send_fds_with_buffer(int, const int *, unsigned, void *);
|
||
|
|
/*
|
||
|
|
* ancil_send_fds_with_buffer(sock, n_fds, fds, buffer)
|
||
|
|
*
|
||
|
|
* Sends the file descriptors in the array pointed by fds, of length n_fds
|
||
|
|
* on the socket sock.
|
||
|
|
* buffer is a writeable memory area large enough to hold the required data
|
||
|
|
* structures.
|
||
|
|
* Returns: -1 and errno in case of error, 0 in case of success.
|
||
|
|
*/
|
||
|
|
|
||
|
|
extern int
|
||
|
|
ancil_recv_fds_with_buffer(int, int *, unsigned, void *);
|
||
|
|
/*
|
||
|
|
* ancil_recv_fds_with_buffer(sock, n_fds, fds, buffer)
|
||
|
|
*
|
||
|
|
* Receives *n_fds file descriptors into the array pointed by fds
|
||
|
|
* from the socket sock.
|
||
|
|
* buffer is a writeable memory area large enough to hold the required data
|
||
|
|
* structures.
|
||
|
|
* Returns: -1 and errno in case of error, the actual number of received fd
|
||
|
|
* in case of success
|
||
|
|
*/
|
||
|
|
|
||
|
|
#define ANCIL_FD_BUFFER(n) \
|
||
|
|
struct { \
|
||
|
|
struct cmsghdr h; \
|
||
|
|
int fd[n]; \
|
||
|
|
}
|
||
|
|
/* ANCIL_FD_BUFFER(n)
|
||
|
|
*
|
||
|
|
* A structure type suitable to be used as buffer for n file descriptors.
|
||
|
|
* Requires <sys/socket.h>.
|
||
|
|
* Example:
|
||
|
|
* ANCIL_FD_BUFFER(42) buffer;
|
||
|
|
* ancil_recv_fds_with_buffer(sock, 42, my_fds, &buffer);
|
||
|
|
*/
|
||
|
|
|
||
|
|
extern int
|
||
|
|
ancil_send_fds(int, const int *, unsigned);
|
||
|
|
/*
|
||
|
|
* ancil_send_fds(sock, n_fds, fds)
|
||
|
|
*
|
||
|
|
* Sends the file descriptors in the array pointed by fds, of length n_fds
|
||
|
|
* on the socket sock.
|
||
|
|
* n_fds must not be greater than ANCIL_MAX_N_FDS.
|
||
|
|
* Returns: -1 and errno in case of error, 0 in case of success.
|
||
|
|
*/
|
||
|
|
|
||
|
|
extern int
|
||
|
|
ancil_recv_fds(int, int *, unsigned);
|
||
|
|
/*
|
||
|
|
* ancil_recv_fds(sock, n_fds, fds)
|
||
|
|
*
|
||
|
|
* Receives *n_fds file descriptors into the array pointed by fds
|
||
|
|
* from the socket sock.
|
||
|
|
* *n_fds must not be greater than ANCIL_MAX_N_FDS.
|
||
|
|
* Returns: -1 and errno in case of error, the actual number of received fd
|
||
|
|
* in case of success.
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
extern int
|
||
|
|
ancil_send_fd(int, int);
|
||
|
|
/* ancil_recv_fd(sock, fd);
|
||
|
|
*
|
||
|
|
* Sends the file descriptor fd on the socket sock.
|
||
|
|
* Returns : -1 and errno in case of error, 0 in case of success.
|
||
|
|
*/
|
||
|
|
|
||
|
|
extern int
|
||
|
|
ancil_recv_fd(int, int *);
|
||
|
|
/* ancil_send_fd(sock, &fd);
|
||
|
|
*
|
||
|
|
* Receives the file descriptor fd from the socket sock.
|
||
|
|
* Returns : -1 and errno in case of error, 0 in case of success.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* ANCILLARY_H__ */
|