mptcpd
Multipath TCP Daemon
path_manager.h
Go to the documentation of this file.
1// SPDX-License-Identifier: BSD-3-Clause
10#ifndef MPTCPD_LIB_PATH_MANAGER_H
11#define MPTCPD_LIB_PATH_MANAGER_H
12
13#include <mptcpd/export.h>
14#include <mptcpd/types.h>
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
20struct sockaddr;
21struct mptcpd_pm;
22struct mptcpd_addr_info;
23
40{
50 void (*ready)(struct mptcpd_pm *pm, void *user_data);
51
62 void (*not_ready)(struct mptcpd_pm *pm, void *user_data);
63};
64
81MPTCPD_API bool mptcpd_pm_register_ops(struct mptcpd_pm *pm,
82 struct mptcpd_pm_ops const *ops,
83 void *user_data);
84
98MPTCPD_API bool mptcpd_pm_ready(struct mptcpd_pm const *pm);
99
107
120MPTCPD_API int mptcpd_pm_add_addr(struct mptcpd_pm *pm,
121 struct sockaddr const *addr,
122 mptcpd_aid_t id,
123 mptcpd_token_t token);
124
137MPTCPD_API int mptcpd_pm_remove_addr(struct mptcpd_pm *pm,
138 mptcpd_aid_t address_id,
139 mptcpd_token_t token);
140
161MPTCPD_API int
163 mptcpd_token_t token,
164 mptcpd_aid_t local_address_id,
165 mptcpd_aid_t remote_address_id,
166 struct sockaddr const *local_addr,
167 struct sockaddr const *remote_addr,
168 bool backup);
169
184MPTCPD_API int mptcpd_pm_set_backup(
185 struct mptcpd_pm *pm,
186 mptcpd_token_t token,
187 struct sockaddr const *local_addr,
188 struct sockaddr const *remote_addr,
189 bool backup);
190
203MPTCPD_API int mptcpd_pm_remove_subflow(
204 struct mptcpd_pm *pm,
205 mptcpd_token_t token,
206 struct sockaddr const *local_addr,
207 struct sockaddr const *remote_addr);
209
218
236MPTCPD_API int mptcpd_kpm_add_addr(struct mptcpd_pm *pm,
237 struct sockaddr const *addr,
238 mptcpd_aid_t id,
239 mptcpd_flags_t flags,
240 int index);
241
253MPTCPD_API int mptcpd_kpm_remove_addr(struct mptcpd_pm *pm,
254 mptcpd_aid_t address_id);
255
270MPTCPD_API int mptcpd_kpm_get_addr(struct mptcpd_pm *pm,
271 mptcpd_aid_t id,
273 void *data,
274 mptcpd_complete_func_t complete);
275
290MPTCPD_API int mptcpd_kpm_dump_addrs(struct mptcpd_pm *pm,
292 void *data,
293 mptcpd_complete_func_t complete);
294
304MPTCPD_API int mptcpd_kpm_flush_addrs(struct mptcpd_pm *pm);
305
315MPTCPD_API int mptcpd_kpm_set_limits(struct mptcpd_pm *pm,
316 struct mptcpd_limit const *limits,
317 size_t len);
318
329MPTCPD_API int mptcpd_kpm_get_limits(struct mptcpd_pm *pm,
331 void *data);
332
342MPTCPD_API int mptcpd_kpm_set_flags(struct mptcpd_pm *pm,
343 struct sockaddr const *addr,
344 mptcpd_flags_t flags);
345
347
355MPTCPD_API struct mptcpd_nm const *
356mptcpd_pm_get_nm(struct mptcpd_pm const *pm);
357
368MPTCPD_API struct mptcpd_idm *
369mptcpd_pm_get_idm(struct mptcpd_pm const *pm);
370
371#ifdef __cplusplus
372}
373#endif
374
375#endif // MPTCPD_LIB_PATH_MANAGER_H
376
377/*
378 Local Variables:
379 c-file-style: "linux"
380 End:
381*/
mptcpd shared library symbol export/import macros.
MPTCPD_API int mptcpd_pm_add_addr(struct mptcpd_pm *pm, struct sockaddr const *addr, mptcpd_aid_t id, mptcpd_token_t token)
Advertise new network address to peers.
Definition: path_manager.c:241
MPTCPD_API struct mptcpd_idm * mptcpd_pm_get_idm(struct mptcpd_pm const *pm)
Get pointer to the global MPTCP address ID manager.
Definition: path_manager.c:367
MPTCPD_API int mptcpd_pm_remove_subflow(struct mptcpd_pm *pm, mptcpd_token_t token, struct sockaddr const *local_addr, struct sockaddr const *remote_addr)
Remove a subflow.
Definition: path_manager.c:337
MPTCPD_API int mptcpd_kpm_set_flags(struct mptcpd_pm *pm, struct sockaddr const *addr, mptcpd_flags_t flags)
Set MPTCP flags for a local IP address.
Definition: path_manager.c:220
MPTCPD_API int mptcpd_pm_set_backup(struct mptcpd_pm *pm, mptcpd_token_t token, struct sockaddr const *local_addr, struct sockaddr const *remote_addr, bool backup)
Set priority of a subflow.
Definition: path_manager.c:312
MPTCPD_API int mptcpd_kpm_get_limits(struct mptcpd_pm *pm, mptcpd_pm_get_limits_cb callback, void *data)
Get MPTCP resource limits.
Definition: path_manager.c:201
MPTCPD_API int mptcpd_kpm_flush_addrs(struct mptcpd_pm *pm)
Flush MPTCP addresses.
Definition: path_manager.c:165
MPTCPD_API int mptcpd_kpm_dump_addrs(struct mptcpd_pm *pm, mptcpd_kpm_get_addr_cb_t callback, void *data, mptcpd_complete_func_t complete)
Get list (array) of MPTCP network addresses.
Definition: path_manager.c:145
MPTCPD_API bool mptcpd_pm_register_ops(struct mptcpd_pm *pm, struct mptcpd_pm_ops const *ops, void *user_data)
Subscribe to mptcpd path manager events.
Definition: path_manager.c:48
MPTCPD_API struct mptcpd_nm const * mptcpd_pm_get_nm(struct mptcpd_pm const *pm)
Get pointer to the underlying network monitor.
Definition: path_manager.c:362
MPTCPD_API int mptcpd_kpm_set_limits(struct mptcpd_pm *pm, struct mptcpd_limit const *limits, size_t len)
Set MPTCP resource limits.
Definition: path_manager.c:182
MPTCPD_API int mptcpd_pm_remove_addr(struct mptcpd_pm *pm, mptcpd_aid_t address_id, mptcpd_token_t token)
Stop advertising network address to peers.
Definition: path_manager.c:264
MPTCPD_API bool mptcpd_pm_ready(struct mptcpd_pm const *pm)
Is mptcpd path manager ready for use?
Definition: path_manager.c:75
MPTCPD_API int mptcpd_kpm_get_addr(struct mptcpd_pm *pm, mptcpd_aid_t id, mptcpd_kpm_get_addr_cb_t callback, void *data, mptcpd_complete_func_t complete)
Get network address corresponding to an address ID.
Definition: path_manager.c:124
MPTCPD_API int mptcpd_kpm_add_addr(struct mptcpd_pm *pm, struct sockaddr const *addr, mptcpd_aid_t id, mptcpd_flags_t flags, int index)
Advertise new network address to peers.
Definition: path_manager.c:82
MPTCPD_API int mptcpd_kpm_remove_addr(struct mptcpd_pm *pm, mptcpd_aid_t address_id)
Stop advertising network address to peers.
Definition: path_manager.c:107
MPTCPD_API int mptcpd_pm_add_subflow(struct mptcpd_pm *pm, mptcpd_token_t token, mptcpd_aid_t local_address_id, mptcpd_aid_t remote_address_id, struct sockaddr const *local_addr, struct sockaddr const *remote_addr, bool backup)
Create a new subflow.
Definition: path_manager.c:283
Information associated with a network address.
Definition: addr_info.h:32
Internal mptcpd address ID manager data.
Definition: id_manager.c:45
MPTCP resource type/limit pair.
Definition: types.h:97
Data needed to run the network monitor.
Definition: network_monitor.c:63
Path manager event tracking operations.
Definition: path_manager.h:40
void(* not_ready)(struct mptcpd_pm *pm, void *user_data)
Callback triggered when the path manager is not ready.
Definition: path_manager.h:62
void(* ready)(struct mptcpd_pm *pm, void *user_data)
Callback triggered when the path manager is ready.
Definition: path_manager.h:50
Data needed to run the path manager.
Definition: path_manager.h:43
mptcpd user space path manager attribute types.
void(* mptcpd_kpm_get_addr_cb_t)(struct mptcpd_addr_info const *info, void *callback_data)
Type of function called when an address is available.
Definition: types.h:118
uint32_t mptcpd_flags_t
MPTCP flags type.
Definition: types.h:51
void(* mptcpd_pm_get_limits_cb)(struct mptcpd_limit const *limits, size_t len, void *callback_data)
Type of function called when MPTCP resource limits are available.
Definition: types.h:160
uint32_t mptcpd_token_t
MPTCP connection token type.
Definition: types.h:26
void(* mptcpd_complete_func_t)(void *user_data)
Type of function called on asynchronous call completion.
Definition: types.h:144
uint8_t mptcpd_aid_t
MPTCP address ID type.
Definition: types.h:29