Qpid Proton C API  0.37.0
netaddr.h
Go to the documentation of this file.
1 #ifndef PROTON_NETADDR_H
2 #define PROTON_NETADDR_H
3 
4 /*
5  * Licensed to the Apache Software Foundation (ASF) under one
6  * or more contributor license agreements. See the NOTICE file
7  * distributed with this work for additional information
8  * regarding copyright ownership. The ASF licenses this file
9  * to you under the Apache License, Version 2.0 (the
10  * "License"); you may not use this file except in compliance
11  * with the License. You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing,
16  * software distributed under the License is distributed on an
17  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18  * KIND, either express or implied. See the License for the
19  * specific language governing permissions and limitations
20  * under the License.
21  */
22 
23 #include <proton/import_export.h>
24 #include <proton/types.h>
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
42 typedef struct pn_netaddr_t pn_netaddr_t;
43 
50 PNP_EXTERN int pn_netaddr_str(const pn_netaddr_t *addr, char *buf, size_t size);
51 
57 
63 
81 
86 PNP_EXTERN const pn_netaddr_t *pn_netaddr_next(const pn_netaddr_t *na);
87 
88 struct sockaddr;
89 
94 PNP_EXTERN const struct sockaddr *pn_netaddr_sockaddr(const pn_netaddr_t *na);
95 
100 PNP_EXTERN size_t pn_netaddr_socklen(const pn_netaddr_t *na);
101 
106 PNP_EXTERN int pn_netaddr_host_port(const pn_netaddr_t* na, char *host, size_t hlen, char *port, size_t plen);
107 
111 PN_DEPRECATED("Use pn_transport_local_addr")
113 
117 PN_DEPRECATED("Use pn_transport_remote_addr")
119 
123 PN_DEPRECATED("Use pn_listener_addr")
125 
130 #ifdef __cplusplus
131 }
132 #endif
133 
134 #endif /* PROTON_NETADDR_H */
struct pn_listener_t pn_listener_t
A listener for incoming connections.
Definition: types.h:424
PNP_EXTERN const struct sockaddr * pn_netaddr_sockaddr(const pn_netaddr_t *na)
On POSIX or Windows, get the underlying struct sockaddr.
PNP_EXTERN const pn_netaddr_t * pn_transport_remote_addr(pn_transport_t *t)
Get the local address of a transport.
PNP_EXTERN const pn_netaddr_t * pn_netaddr_remote(pn_transport_t *t)
Deprecated - Use pn_transport_remote_addr()
PNP_EXTERN const pn_netaddr_t * pn_netaddr_next(const pn_netaddr_t *na)
struct pn_netaddr_t pn_netaddr_t
Unsettled API - The network address of a proactor transport.
Definition: netaddr.h:42
PNP_EXTERN const pn_netaddr_t * pn_netaddr_local(pn_transport_t *t)
Deprecated - Use pn_transport_local_addr()
PNP_EXTERN const pn_netaddr_t * pn_transport_local_addr(pn_transport_t *t)
Get the local address of a transport.
PNP_EXTERN int pn_netaddr_host_port(const pn_netaddr_t *na, char *host, size_t hlen, char *port, size_t plen)
Get the host and port name from na as separate strings.
PNP_EXTERN const pn_netaddr_t * pn_netaddr_listening(pn_listener_t *l)
Deprecated - Use pn_listener_addr()
PNP_EXTERN int pn_netaddr_str(const pn_netaddr_t *addr, char *buf, size_t size)
Format a network address string in buf.
PNP_EXTERN const pn_netaddr_t * pn_listener_addr(pn_listener_t *l)
Get the listening addresses of a listener.
PNP_EXTERN size_t pn_netaddr_socklen(const pn_netaddr_t *na)
On POSIX or Windows, get the size of the underlying struct sockaddr.
struct pn_transport_t pn_transport_t
A network channel supporting an AMQP connection.
Definition: types.h:435
AMQP and API data types.