Added comments

FossilOrigin-Name: 2aa841059ef11738f97159e92b1e9ae98b304a7a2fce7e98d22a5ca4b3ee0bd0
This commit is contained in:
7u83@mail.ru 2016-03-06 10:08:16 +00:00
parent 747dc5e1c2
commit 130df27488
1 changed files with 30 additions and 8 deletions

View File

@ -1,7 +1,7 @@
/* /*
This file is part of libcapwap. This file is part of actube.
libcapwap is free software: you can redistribute it and/or modify actube is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or the Free Software Foundation, either version 3 of the License, or
(at your option) any later version. (at your option) any later version.
@ -16,6 +16,7 @@
*/ */
/** /**
*@file *@file
*@breif *@breif
@ -55,7 +56,7 @@ extern int sock_getifaddr(const char *ifname, int family, int type, struct socka
extern int sock_getifhwaddr(const char *ifname, uint8_t * hwaddr, uint8_t * addrlen); extern int sock_getifhwaddr(const char *ifname, uint8_t * hwaddr, uint8_t * addrlen);
extern char *sock_hwaddrtostr(const uint8_t * haddr, int len, char *dst, extern char *sock_hwaddrtostr(const uint8_t * haddr, int len, char *dst,
const char *separator); const char *separator);
extern char *sock_addrtostr(const struct sockaddr *sa, char *s, size_t maxlen); //extern char *sock_addrtostr(const struct sockaddr *sa, char *s, size_t maxlen);
extern int sock_strtoaddr(const char *s, struct sockaddr *saout); extern int sock_strtoaddr(const char *s, struct sockaddr *saout);
extern int sock_set_recvtimeout(int sock, int seconds); extern int sock_set_recvtimeout(int sock, int seconds);
@ -74,16 +75,37 @@ extern int sock_getifinfo(const struct sockaddr *addr, char *ifname,
char *sock_strsockaddr(const struct sockaddr *sa, char *s, size_t maxlen, int addport); char *sock_addrtostr(const struct sockaddr *sa, char *s, size_t maxlen, int addport);
int sock_parse_ip_address ( const char** ppszText,
unsigned char* abyAddr, int* pnPort, int* pbIsIPv6 );
/**
* Convert a sockaddr structure to a human readable string
* @param s sockaddr
* @return A char* pointer to converted address
*
* The returned string is pushed on the stack (unnamed variable), so this macro should
* only be used as function argument.
*
* Example:
* \code
struct sockaddr sa;
// Initialize sa ...
sprintf("Adress: %s",sock_addr2str(&sa));
\endcode
*/
#define sock_addr2str(s) ( sock_addrtostr( (struct sockaddr*)s, (char[64]){0}, 64, 0 ) )
/**
* Same as #sock_addr2str, but also the port number is appended to the result
* @see #sock_addr2str
*/
#define sock_addr2str_p(s) ( sock_addrtostr( (struct sockaddr*)s, (char[64]){0}, 64,1 ) )
#define sock_addr2str(s) ( sock_strsockaddr( (struct sockaddr*)s, (char[64]){0}, 64,0 ) )
#define sock_hwaddr2str(s,l) ( sock_hwaddrtostr( s,l, (char[64]){0}, ":" ) ) #define sock_hwaddr2str(s,l) ( sock_hwaddrtostr( s,l, (char[64]){0}, ":" ) )
#define sock_hwaddr2idstr(s,l) ( sock_hwaddrtostr( s,l, (char[64]){0}, "" ) ) #define sock_hwaddr2idstr(s,l) ( sock_hwaddrtostr( s,l, (char[64]){0}, "" ) )
#define sock_addrtostr(s,str,n) sock_strsockaddr(s,str,n,1) //#define sock_addrtostr(s,str,n) sock_addrtostr(s,str,n,1)
#define sock_addrfamily(addr) ( ((struct sockaddr_storage*)(addr))->ss_family ) #define sock_addrfamily(addr) ( ((struct sockaddr_storage*)(addr))->ss_family )