Changeset 1613 for pjproject/trunk/pjlib/include/pj/sock.h

Timestamp:

Dec 3, 2007 2:33:39 PM (16 years ago)

Author:

bennylp

Message:

More ticket #415: Added pj_sockaddr_cmp(), pj_sockaddr_copy_addr(), and pj_sockaddr_print()

File:

• pjproject/trunk/pjlib/include/pj/sock.h (modified) (5 diffs)

pjproject/trunk/pjlib/include/pj/sock.h

@@ -596 +596 @@
  * This function converts a numeric address into a text string suitable
  * for presentation. It supports both IPv4 and IPv6 address
- * conversion.
+ * conversion. 
+ * @see pj_sockaddr_print()
  *
  * @param af    Specify the family of the address. This can be PJ_AF_INET
@@ -616 +617 @@
 /**
  * Converts numeric address into its text string representation.
+ * @see pj_sockaddr_print()
  *
  * @param af    Specify the family of the address. This can be PJ_AF_INET
@@ -633 +635 @@
                              char *dst, int size);
 
+/**
+ * Print socket address.
+ *
+ * @param addr  The socket address.
+ * @param buf   Text buffer.
+ * @param size  Size of buffer.
+ * @param flags Bitmask combination of these value:
+ *                - 1: port number is included.
+ *                - 2: square bracket is included for IPv6 address.
+ *
+ * @return      The address string.
+ */
+PJ_DECL(char*) pj_sockaddr_print(const pj_sockaddr_t *addr,
+                                 char *buf, int size,
+                                 unsigned flags);
 
 /**
@@ -703 +720 @@
 
 /**
+ * Compare two socket addresses.
+ *
+ * @param addr1     First address.
+ * @param addr2     Second address.
+ *
+ * @return          Zero on equal, -1 if addr1 is less than addr2,
+ *                  and +1 if addr1 is more than addr2.
+ */
+PJ_DECL(int) pj_sockaddr_cmp(const pj_sockaddr_t *addr1,
+                             const pj_sockaddr_t *addr2);
+
+/**
  * Get pointer to the address part of a socket address.
  * 
@@ -743 +772 @@
 PJ_DECL(unsigned) pj_sockaddr_get_len(const pj_sockaddr_t *addr);
 
+/** 
+ * Copy only the address part (sin_addr/sin6_addr) of a socket address.
+ *
+ * @param dst       Destination socket address.
+ * @param src       Source socket address.
+ */
+PJ_DECL(void) pj_sockaddr_copy_addr(pj_sockaddr *dst,
+                                    const pj_sockaddr *src);
 /**
  * Get the IP address of an IPv4 socket address.