clib/doc.md

[TOC]

函数列表

注意事项

具体函数请点击链接或打开doc文件夹直接查找

套接字函数 ssocket.h

socket套接字相关

static inline int make_server_sock(SOCKET* sock, const char* server_ip, unsigned short port);

初始化服务器类型的socket,推荐使用(使用内置函数优化效率,返回0表示成功

static inline int make_client_sock(SOCKET* sock, const char* connect_ip, unsigned short port);

初始化客户端类型的socket,推荐使用(使用内置函数优化效率),返回0表示成功

static inline int sock_accpet(SOCKET sock,SOCKET* client, char** accept_ip, unsigned short* port);

将有效的套接字绑定并监听网络以提供套接字服务,返回0表示成功

static inline int sock_connect(SOCKET sock, const char* connect_ip, unsigned short port);

将有效的套接字连接到相应的套接字服务,用于客户端,返回0表示成功

static inline void close_sock(SOCKET sock);

关闭套接字接口

static inline int make_server_sock_ex(SOCKET* sock, const char* server_ip, unsigned short port, struct addrinfo** resaddr);

初始化服务器类型的socket,推荐使用(使用内置函数优化效率),返回0表示成功

static inline int make_client_sock_ex(SOCKET* sock, const char* connect_ip, unsigned short port, struct addrinfo** resaddr);

初始化客户端类型的socket,推荐使用(使用内置函数优化效率),返回0表示成功

内置函数

static inline int _getaddrinfo(struct addrinfo* inf, struct addrinfo** resaddr, const char* ip, const char* port);

使用字符串自动匹配相应的信息,返回addrinfo(用于sockaddr),内部使用getaddrinfo系统函数生成addrinfo

注意使用freeaddrinfo销毁resaddr

返回0表示成功

static inline int _socket(SOCKET* sock, struct addrinfo* resaddr);

使用addinfo创建socket套接字,内部使用socket系统函数(未加入Windows部分的初始化网络接口)

返回0表示成功

static inline int _connect(SOCKET sock, struct addrinfo* resaddr);

使用addinfo连接到服务器,内部使用connect系统函数

返回0表示成功

static inline int _bind(SOCKET sock, struct addrinfo* resaddr);

使用addinfo绑定地址到socket套接字,用于服务器,内部使用bind系统函数

返回0表示成功

static inline int _bindlisten(SOCKET sock, struct addrinfo* resaddr);

使用addinfo绑定并监听地址,用于tcp服务器,内部使用bind和listen系统函数

返回0表示成功

static inline int _accept(SOCKET sock, SOCKET* client, struct addrinfo* inf);

使用已经绑定监听的套接字接口以接收客户端的连接客户端的信息返回在addrinfo中,用于tcp服务器,内部使用accept系统函数

返回0表示成功

static inline int _sock(SOCKET* sock, int af, int type);

打开套接字接口(在Windows部分加入了初始化网络接口)

返回0表示成功

手动创建socket

static inline int make_sock_tcp4(SOCKET* sock);

初始化用于tcp-ipv4套接字接口,返回0表示成功

static inline int make_sock_tcp6(SOCKET* sock);

初始化用于tcp-ipv6套接字接口,返回0表示成功

static inline int make_sock_udp4(SOCKET* sock);

初始化用于udp-ipv4套接字接口,返回0表示成功

static inline int make_sock_udp6(SOCKET* sock);

初始化用于udp-ipv6套接字接口,返回0表示成功

static inline int make_sock(SOCKET* sock);

初始化套接字接口属于make_sock_tcp4的别名,返回0表示成功

不推荐,仅用于测试,将在未来版本删除

static inline int sock_bind(SOCKET sock, const char* server_ip, unsigned short port);

将有效的套接字绑定网络以提供套接字服务,用于服务器,返回0表示成功

static inline int sock_bindlisten(SOCKET sock, const char* server_ip, unsigned short port);

将有效的套接字绑定并监听网络以提供套接字服务,用于tcp服务器,返回0表示成功

错误处理(暂时未启用)

static inline void out_sock_err(FILE* output, int errcode);

static inline void get_sock_err(char* buff_128, size_t buff_len, int errcode);

线程函数 tthread.h

thread线程相关

static inline int thread_create(TID* tid, void(*start_routine)(void*), void* arg);

创建线程,返回0表示成功

static inline void thread_exit(void);

退出当前线程

static inline int thread_join(TID tid);

等待线程结束,返回0表示成功

static inline TID thread_self(void);

获取当前线程的TID,返回0表示成功

mutex互斥锁相关

static inline int thread_mutex_init(MUTEX* mutex);

初始化mutex互斥锁,使其属于解锁状态,返回0表示成功

static inline int thread_mutex_destroy(MUTEX* mutex);

销毁mutex互斥锁,返回0表示成功

static inline int thread_mutex_lock(MUTEX* mutex);

等待mutex处于解锁状态并阻塞于此,若mutex为解锁状态则同一时刻有且仅有一个函数返回,且返回后mutex置为锁定状态

用于加锁

返回0表示成功

static inline int thread_mutex_unlock(MUTEX* mutex);

将处于锁定状态的mutex重置于解锁状态

用于解锁

返回0表示成功

cond信号量相关

static inline int thread_cond_init(COND* cond);

初始化cond信号量,并将其处于关闭状态,返回0表示成功

static inline int thread_cond_destroy(COND* cond);

销毁cond信号量,返回0表示成功

static inline int thread_cond_singal(COND* cond);

将信号量置于打开状态一次,即同一时刻有且仅有一个函数的信号量置于打开状态,返回0表示成功

(激活一个等待该条件cond的线程,存在多个等待线程时按入队顺序激活其中一个)

static inline int thread_cond_broadcast(COND* cond);

使所有信号量处于打开状态,返回0表示成功

(激活所有等待cond的线程)

static inline int thread_cond_wait(COND* cond, MUTEX* mutex);

等待从cond处于打开状态并一阻塞于此(实际是线程挂起)

返回0表示成功

注意: mutex在调用thread_cond_wait()等系列函数前必须由本线程加锁 (thread_mutex_lock()), 而在更新条件等待队列以前, mutex保持锁定状态, 并在线程挂起进入等待前解锁. 在条件满足从而离开thread_cond_wait()之前, mutex将被重新加锁, 以与进 thread_cond_wait()前的加锁动作对应. 阻塞时处于解锁状态.

static inline int thread_cond_timedwait(COND* cond, MUTEX* mutex, int ms);

请在此之前使用thread_mutex_lock,保证mutex处于使用状态

等待从cond处于打开状态并一阻塞于此(实际是线程挂起),若超出时间则直接返回并返回 -ERR_THREAD_COND_TIME_OUT;

返回0表示成功

注意: mutex在调用thread_cond_wait()等系列函数前必须由本线程加锁 (thread_mutex_lock()), 而在更新条件等待队列以前, mutex保持锁定状态, 并在线程挂起进入等待前解锁. 在条件满足从而离开thread_cond_wait()之前, mutex将被重新加锁, 以与进 thread_cond_wait()前的加锁动作对应. 阻塞时处于解锁状态.

stdio标准函数的线程安全

static inline int tprintf(MUTEX* mutex, const char* format, ...);

static inline int tfprintf(MUTEX* mutex, FILE* const stream, const char* format, ...);

static inline int tsprintf(MUTEX* mutex, char* const buffer, const char* format, ...);

static inline int tsnprintf(MUTEX* mutex, char* const buffer, const size_t buffer_count, const char* format, ...);

static inline int tvprintf(MUTEX* mutex, const char* format, va_list arglist);

static inline int tvfprintf(MUTEX* mutex, FILE* const stream, const char* format, va_list arglist);

static inline int tvsprintf(MUTEX* mutex, char* const buffer, const char* format, va_list arglist);

static inline int tvsnprintf(MUTEX* mutex, char* const buffer, const size_t buffer_count, const char* format, va_list arglist);