xan/patty
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add comments to include/ax25/sock.h functions

Browse source 
Add comments to include/ax25/sock.h functions to improve readability
This commit is contained in:
XANTRONIX Development 2020-08-14 17:37:23 -04:00 • committed by XANTRONIX Industrial
parent 004d5c9ec6
commit a5fe9be054
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
include/patty/ax25/sock.h
View file

@ -138,6 +138,9 @@ typedef struct _patty_ax25_sock {
unsigned int hops; unsigned int hops;
} patty_ax25_sock; } patty_ax25_sock;
/*
* Socket instantiation, destruction and initialization
*/
patty_ax25_sock *patty_ax25_sock_new(enum patty_ax25_proto proto, patty_ax25_sock *patty_ax25_sock_new(enum patty_ax25_proto proto,
enum patty_ax25_sock_type type); enum patty_ax25_sock_type type);
@ -147,6 +150,9 @@ void patty_ax25_sock_init(patty_ax25_sock *sock);
void patty_ax25_sock_reset(patty_ax25_sock *sock); void patty_ax25_sock_reset(patty_ax25_sock *sock);
/*
* Setters for specific parameters
*/
void patty_ax25_sock_mtu_set(patty_ax25_sock *sock, size_t mtu); void patty_ax25_sock_mtu_set(patty_ax25_sock *sock, size_t mtu);
void patty_ax25_sock_ack_set(patty_ax25_sock *sock, time_t ack); void patty_ax25_sock_ack_set(patty_ax25_sock *sock, time_t ack);
@ -155,6 +161,9 @@ void patty_ax25_sock_window_set(patty_ax25_sock *sock, size_t window);
void patty_ax25_sock_retry_set(patty_ax25_sock *sock, size_t retry); void patty_ax25_sock_retry_set(patty_ax25_sock *sock, size_t retry);
/*
* AX.25 version-specific parameter defaults and negotiation
*/
void patty_ax25_sock_params_upgrade(patty_ax25_sock *sock); void patty_ax25_sock_params_upgrade(patty_ax25_sock *sock);
void patty_ax25_sock_params_max(patty_ax25_sock *sock); void patty_ax25_sock_params_max(patty_ax25_sock *sock);
@ -162,6 +171,9 @@ void patty_ax25_sock_params_max(patty_ax25_sock *sock);
int patty_ax25_sock_params_negotiate(patty_ax25_sock *sock, int patty_ax25_sock_params_negotiate(patty_ax25_sock *sock,
patty_ax25_params *params); patty_ax25_params *params);
/*
* TX/RX buffer allocation
*/
int patty_ax25_sock_realloc_bufs(patty_ax25_sock *sock); int patty_ax25_sock_realloc_bufs(patty_ax25_sock *sock);
char *patty_ax25_sock_pty(patty_ax25_sock *sock); char *patty_ax25_sock_pty(patty_ax25_sock *sock);
@ -169,10 +181,16 @@ char *patty_ax25_sock_pty(patty_ax25_sock *sock);
int patty_ax25_sock_bind_if(patty_ax25_sock *sock, int patty_ax25_sock_bind_if(patty_ax25_sock *sock,
patty_ax25_if *iface); patty_ax25_if *iface);
/*
* Stream-oriented state management
*/
void patty_ax25_sock_vs_incr(patty_ax25_sock *sock); void patty_ax25_sock_vs_incr(patty_ax25_sock *sock);
void patty_ax25_sock_vr_incr(patty_ax25_sock *sock); void patty_ax25_sock_vr_incr(patty_ax25_sock *sock);
/*
* Socket I/O methods
*/
ssize_t patty_ax25_sock_send(patty_ax25_sock *sock, ssize_t patty_ax25_sock_send(patty_ax25_sock *sock,
void *buf, void *buf,
size_t len); size_t len);