diff options
| author | Matt Caswell <matt@openssl.org> | 2016-02-05 19:40:44 +0000 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2016-02-05 20:47:36 +0000 |
| commit | 7d1d48a2d0a08567f5c8e14d50d89a9b47c02f1d (patch) | |
| tree | 4e06fa9430101a0f83e3876575c4c39eebf7f4a1 /doc | |
| parent | 0d4fb8439092ff8253af72ac6bc193e77ebbcf2f (diff) | |
Add a BIO_ADDR_clear function
Adds a new function BIO_ADDR_clear to reset a BIO_ADDR back to an
unitialised state, and to set the family to AF_UNSPEC.
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/crypto/BIO_ADDR.pod | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/crypto/BIO_ADDR.pod b/doc/crypto/BIO_ADDR.pod index cec7dddd7e..a3c9b5cfaf 100644 --- a/doc/crypto/BIO_ADDR.pod +++ b/doc/crypto/BIO_ADDR.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_ADDR, BIO_ADDR_new, BIO_ADDR_free, BIO_ADDR_rawmake, +BIO_ADDR, BIO_ADDR_new, BIO_ADDR_clear, BIO_ADDR_free, BIO_ADDR_rawmake, BIO_ADDR_family, BIO_ADDR_rawaddress, BIO_ADDR_rawport, BIO_ADDR_hostname_string, BIO_ADDR_service_string, BIO_ADDR_path_string - BIO_ADDR routines @@ -16,6 +16,7 @@ BIO_ADDR_path_string - BIO_ADDR routines BIO_ADDR *BIO_ADDR_new(void); void BIO_ADDR_free(BIO_ADDR *); + void BIO_ADDR_clear(BIO_ADDR *ap); int BIO_ADDR_rawmake(BIO_ADDR *ap, int family, const void *where, size_t wherelen, unsigned short port); int BIO_ADDR_family(const BIO_ADDR *ap); @@ -38,6 +39,9 @@ BIO_accept_ex(). BIO_ADDR_free() frees a B<BIO_ADDR> created with BIO_ADDR_new(). +BIO_ADDR_clear() clears any data held within the provided B<BIO_ADDR> and sets +it back to an uninitialised state. + BIO_ADDR_rawmake() takes a protocol B<family>, an byte array of size B<wherelen> with an address in network byte order pointed at by B<where> and a port number in network byte order in B<port> (except @@ -50,7 +54,8 @@ I<Read on about the addresses in L</RAW ADDRESSES> below>. BIO_ADDR_family() returns the protocol family of the given B<BIO_ADDR>. The possible non-error results are one of the -constants AF_INET, AF_INET6 and AF_UNIX. +constants AF_INET, AF_INET6 and AF_UNIX. It will also return AF_UNSPEC if the +BIO_ADDR has not been initialised. BIO_ADDR_rawaddress() will write the raw address of the given B<BIO_ADDR> in the area pointed at by B<p> if B<p> is non-NULL, |