blob: d2ce117a2c124645ac793ea7713393be37eb3b77 (
plain)
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
|
/* $Header: /pjproject/pjsip/src/pjsip/sip_resolve.h 5 6/17/05 11:16p Bennylp $ */
#ifndef __PJSIP_SIP_RESOLVE_H__
#define __PJSIP_SIP_RESOLVE_H__
/**
* @file sip_resolve.h
* @brief
* This module contains the mechanism to resolve server address as specified by
* RFC 3263 - Locating SIP Servers
*/
#include <pjsip/sip_types.h>
#include <pj/sock.h>
PJ_BEGIN_DECL
/**
* @defgroup PJSIP_RESOLVE SIP Server Resolver
* @ingroup PJSIP
* @{
*/
/**
* Maximum number of addresses returned by the resolver.
*/
#define PJSIP_MAX_RESOLVED_ADDRESSES 8
typedef struct pjsip_server_addresses pjsip_server_addresses;
/**
* The server addresses returned by the resolver.
*/
struct pjsip_server_addresses
{
/** Number of address records. */
unsigned count;
/** Address records. */
struct
{
/** Preferable transport to be used to contact this address. */
pjsip_transport_type_e type;
/** The server's address. */
pj_sockaddr_in addr;
} entry[PJSIP_MAX_RESOLVED_ADDRESSES];
};
/**
* The type of callback function to be called when resolver finishes the job.
*
* @param status The status of the operation, which is zero on success.
* @param token The token that was associated with the job when application
* call the resolve function.
* @param addr The addresses resolved by the operation.
*/
typedef void pjsip_resolver_callback(pj_status_t status,
void *token,
const struct pjsip_server_addresses *addr);
/**
* Create resolver engine.
*
* @param pool The Pool.
* @return The resolver engine.
*/
PJ_DECL(pjsip_resolver_t*) pjsip_resolver_create(pj_pool_t *pool);
/**
* Destroy resolver engine.
*
* @param resolver The resolver.
*/
PJ_DECL(void) pjsip_resolver_destroy(pjsip_resolver_t *resolver);
/**
* Asynchronously resolve a SIP target host or domain according to rule
* specified in RFC 3263 (Locating SIP Servers). When the resolving operation
* has completed, the callback will be called.
*
* Note: at the moment we don't have implementation of RFC 3263 yet!
*
* @param resolver The resolver engine.
* @param pool The pool to allocate resolver job.
* @param target The target specification to be resolved.
* @param token A user defined token to be passed back to callback function.
* @param cb The callback function.
*/
PJ_DECL(void) pjsip_resolve( pjsip_resolver_t *resolver,
pj_pool_t *pool,
pjsip_host_port *target,
void *token,
pjsip_resolver_callback *cb);
/**
* @}
*/
PJ_END_DECL
#endif /* __PJSIP_SIP_RESOLVE_H__ */
|
