mptcpd
Multipath TCP Daemon
Loading...
Searching...
No Matches
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
124MPTCPD_API int mptcpd_pm_add_addr(struct mptcpd_pm *pm,
125 struct sockaddr *addr,
126 mptcpd_aid_t id,
127 mptcpd_token_t token);
128
143MPTCPD_API int mptcpd_pm_remove_addr(struct mptcpd_pm *pm,
144 struct sockaddr const *addr,
145 mptcpd_aid_t address_id,
146 mptcpd_token_t token);
147
168MPTCPD_API int
170 mptcpd_token_t token,
171 mptcpd_aid_t local_address_id,
172 mptcpd_aid_t remote_address_id,
173 struct sockaddr const *local_addr,
174 struct sockaddr const *remote_addr,
175 bool backup);
176
191MPTCPD_API int mptcpd_pm_set_backup(
192 struct mptcpd_pm *pm,
193 mptcpd_token_t token,
194 struct sockaddr const *local_addr,
195 struct sockaddr const *remote_addr,
196 bool backup);
197
210MPTCPD_API int mptcpd_pm_remove_subflow(
211 struct mptcpd_pm *pm,
212 mptcpd_token_t token,
213 struct sockaddr const *local_addr,
214 struct sockaddr const *remote_addr);
216
225
244MPTCPD_API int mptcpd_kpm_add_addr(struct mptcpd_pm *pm,
245 struct sockaddr const *addr,
246 mptcpd_aid_t id,
247 mptcpd_flags_t flags,
248 int index);
249
261MPTCPD_API int mptcpd_kpm_remove_addr(struct mptcpd_pm *pm,
262 mptcpd_aid_t address_id);
263
278MPTCPD_API int mptcpd_kpm_get_addr(struct mptcpd_pm *pm,
279 mptcpd_aid_t id,
281 void *data,
282 mptcpd_complete_func_t complete);
283
298MPTCPD_API int mptcpd_kpm_dump_addrs(struct mptcpd_pm *pm,
300 void *data,
301 mptcpd_complete_func_t complete);
302
312MPTCPD_API int mptcpd_kpm_flush_addrs(struct mptcpd_pm *pm);
313
323MPTCPD_API int mptcpd_kpm_set_limits(struct mptcpd_pm *pm,
324 struct mptcpd_limit const *limits,
325 size_t len);
326
337MPTCPD_API int mptcpd_kpm_get_limits(struct mptcpd_pm *pm,
339 void *data);
340
351MPTCPD_API int mptcpd_kpm_set_flags(struct mptcpd_pm *pm,
352 struct sockaddr const *addr,
353 mptcpd_flags_t flags);
354
356
364MPTCPD_API struct mptcpd_nm const *
365mptcpd_pm_get_nm(struct mptcpd_pm const *pm);
366
377MPTCPD_API struct mptcpd_idm *
378mptcpd_pm_get_idm(struct mptcpd_pm const *pm);
379
390MPTCPD_API struct mptcpd_lm *
391mptcpd_pm_get_lm(struct mptcpd_pm const *pm);
392
393#ifdef __cplusplus
394}
395#endif
396
397#endif // MPTCPD_LIB_PATH_MANAGER_H
398
399/*
400 Local Variables:
401 c-file-style: "linux"
402 End:
403*/
mptcpd shared library symbol export/import macros.
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:362
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:332
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:214
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:307
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:195
MPTCPD_API int mptcpd_pm_add_addr(struct mptcpd_pm *pm, struct sockaddr *addr, mptcpd_aid_t id, mptcpd_token_t token)
Advertise new network address to peers.
Definition path_manager.c:235
MPTCPD_API int mptcpd_kpm_flush_addrs(struct mptcpd_pm *pm)
Flush MPTCP addresses.
Definition path_manager.c:159
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:139
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:42
MPTCPD_API int mptcpd_pm_remove_addr(struct mptcpd_pm *pm, struct sockaddr const *addr, mptcpd_aid_t address_id, mptcpd_token_t token)
Stop advertising network address to peers.
Definition path_manager.c:258
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:357
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:176
MPTCPD_API bool mptcpd_pm_ready(struct mptcpd_pm const *pm)
Is mptcpd path manager ready for use?
Definition path_manager.c:69
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:118
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:76
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:101
MPTCPD_API struct mptcpd_lm * mptcpd_pm_get_lm(struct mptcpd_pm const *pm)
Get pointer to the global MPTCP listener manager.
Definition path_manager.c:367
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:278
Information associated with a network address.
Definition addr_info.h:32
Internal mptcpd address ID manager data.
Definition id_manager.c:46
MPTCP resource type/limit pair.
Definition types.h:100
Internal mptcpd listern manager data.
Definition listener_manager.c:43
Data needed to run the network monitor.
Definition network_monitor.c:64
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:44
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:121
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:163
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:147
uint8_t mptcpd_aid_t
MPTCP address ID type.
Definition types.h:29