/usr/include/ncbi-vdb/kns/endpoint.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kns_endpoint_
#define _h_kns_endpoint_
#ifndef _h_kns_extern_
#include <kns/extern.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct String;
struct KNSManager;
/*--------------------------------------------------------------------------
* KEndPoint
* describe a socket endpoint
*/
typedef uint32_t KEndPointType;
enum
{
epInvalid,
epIPV4,
epIPV6,
epIPC
};
#define IPC_NAME_MAX 256
typedef struct KEndPoint KEndPoint;
struct KEndPoint
{
union
{
struct
{
uint32_t addr;
uint16_t port;
} ipv4;
struct
{
uint8_t addr[ 16 ];
uint16_t port;
} ipv6;
char ipc_name [ IPC_NAME_MAX ];
} u;
KEndPointType type;
};
/* InitIPv4Endpoint
* initialize the endpoint with an IPv4 address and port
*
* "ep" [ OUT ] - address of endpoint block to be intialized
*
* "ipv4" [ IN, DEFAULT 0 ] - binary IPv4 address in native integer byte order
* i.e. 0x7F000001 represents 127.0.0.1. if the special address 0 is given, it
* represents any host-local interface address.
*
* "port" [ IN, DEFAULT 0 ] - binary port number in native integer byte order.
* if the special port number 0 is given, it represents any available port.
*/
KNS_EXTERN rc_t CC KNSManagerInitIPv4Endpoint ( struct KNSManager const *self,
KEndPoint *ep, uint32_t ipv4, uint16_t port );
/* InitIPv6Endpoint
* initialize the endpoint with an IPv6 address and port
*
* "ep" [ OUT ] - address of endpoint block to be intialized
*
* "ipv6" [ IN, DEFAULT NULL ] - binary IPv6 address in native integer byte order
* has to point to a 16-byte long array ( = 128 bit ). The function will make
* a copy of this array. 0x1 represents 0:0:0:0:0:0:0:1 the loopback-device.
* If the special address ::0 is given, it represents any host-local interface
* address. ( in6addr_any is a 16-byte array with all bytes set to zero )
* If a NULL-pointer is passed in, the function treats it as in6addr_any.
*
* "port" [ IN, DEFAULT 0 ] - binary port number in native integer byte order.
* if the special port number 0 is given, it represents any available port.
*/
KNS_EXTERN rc_t CC KNSManagerInitIPv6Endpoint ( struct KNSManager const *self,
KEndPoint *ep, uint8_t *ipv6, uint16_t port );
/* InitDNSEndpoint
* initialize the endpoint with a DNS name and a port number
*
* "ep" [ OUT ] - address of endpoint block to be intialized
*
* "dns" [ IN ] - textual DNS address.
*
* "port" [ IN, DEFAULT 0 ] - binary port number in native integer byte order.
* if the special port number 0 is given, it represents any available port.
*/
KNS_EXTERN rc_t CC KNSManagerInitDNSEndpoint ( struct KNSManager const *self,
KEndPoint *ep, struct String const *dns, uint16_t port );
/* InitIPCEndpoint
* initialize the endpoint for interprocess communication
*
* "ep" [ OUT ] - address of endpoint block to be intialized
*
* "name" [ IN ] - IPC channel name
* ( a POSIX path to a Unix socket, or a name of a Windows pipe )
*/
KNS_EXTERN rc_t CC KNSManagerInitIPCEndpoint ( struct KNSManager const *self,
KEndPoint *ep, struct String const * name );
#ifdef __cplusplus
}
#endif
#endif /* _h_kns_endpoint_ */
|