BIO_ADDR_path_string (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/BIO_ADDR_path_string.3ssl".)

NAME

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

SYNOPSIS

 #include <sys/types.h>
 #include <openssl/bio.h>

 typedef union bio_addr_st BIO_ADDR;

 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);
 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
 char *BIO_ADDR_path_string(const BIO_ADDR *ap);

DESCRIPTION

The type is a wrapper around all types of socket addresses that OpenSSL deals with, currently transparently supporting and according to what's available on the platform at hand.

BIO_ADDR_new() creates a new unfilled

, to be used with routines that will fill it with information, such as BIO_accept_ex().

BIO_ADDR_free() frees a

created with BIO_ADDR_new().

BIO_ADDR_clear() clears any data held within the provided

and sets it back to an uninitialised state.

BIO_ADDR_rawmake() takes a protocol family, an byte array of size wherelen with an address in network byte order pointed at by where and a port number in network byte order in port (except for the

protocol family, where port is meaningless and therefore ignored) and populates the given with them. In case this creates a , wherelen is expected to be the length of the path string (not including the terminating such as the result of a call to strlen()). Read on about the addresses in `` below.

BIO_ADDR_family() returns the protocol family of the given

. The possible non-error results are one of the constants and It will also return if the has not been initialised.

BIO_ADDR_rawaddress() will write the raw address of the given

in the area pointed at by p if p is non-NULL, and will set *l to be the amount of bytes the raw address takes up if l is non-NULL. A technique to only find out the size of the address is a call with p set to . The raw address will be in network byte order, most significant byte first. In case this is a , l gets the length of the path string (not including the terminating such as the result of a call to strlen()). Read on about the addresses in `` below.

BIO_ADDR_rawport() returns the raw port of the given

. The raw port will be in network byte order.

BIO_ADDR_hostname_string() returns a character string with the hostname of the given

. If numeric is 1, the string will contain the numerical form of the address. This only works for of the protocol families and The returned string has been allocated on the heap and must be freed with OPENSSL_free().

BIO_ADDR_service_string() returns a character string with the service name of the port of the given

. If numeric is 1, the string will contain the port number. This only works for of the protocol families and The returned string has been allocated on the heap and must be freed with OPENSSL_free().

BIO_ADDR_path_string() returns a character string with the path of the given

. This only works for of the protocol family The returned string has been allocated on the heap and must be freed with OPENSSL_free().

RAW ADDRESSES

Both BIO_ADDR_rawmake() and BIO_ADDR_rawaddress() take a pointer to a network byte order address of a specific site. Internally, those are treated as a pointer to struct in_addr (for ), struct in6_addr (for ) or char * (for ), all depending on the protocol family the address is for.

RETURN VALUES

The string producing functions BIO_ADDR_hostname_string(), BIO_ADDR_service_string() and BIO_ADDR_path_string() will return on error and leave an error indication on the OpenSSL error stack.

All other functions described here return 0 or

when the information they should return isn't available.

SEE ALSO

BIO_connect(3), BIO_s_connect(3)

COPYRIGHT

Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the ``License''). You may not use this file except in compliance with the License. You can obtain a copy in the file

in the source distribution or at <www.openssl.org/source/license.html>.