/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
* Jonathan Schleifer <js@heap.zone>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFString.h"
#import "socket.h"
OF_ASSUME_NONNULL_BEGIN
/*! @file */
/*!
* @struct of_resolver_result_t resolver.h ObjFW/resolver.h
*
* @brief A struct representing one result from the resolver.
*/
typedef struct {
int family, type, protocol;
struct sockaddr *address;
socklen_t addressLength;
void *private_;
} of_resolver_result_t;
#ifdef __cplusplus
extern "C" {
#endif
/*!
* @brief Resolves the specified host.
*
* @param host The host to resolve
* @param port The port that should be inserted into the resulting address
* struct
* @param protocol The protocol that should be inserted into the resulting
* address struct
*
* @return An array of results. The list is terminated by NULL and should be
* freed after use.
*/
extern of_resolver_result_t *_Nullable *_Nonnull of_resolve_host(OFString *host,
uint16_t port, int protocol);
/*!
* @brief Converts the specified address to a string and port pair.
*
* @param address The address to convert to a string
* @param addressLength The length of the address to convert to a string
* @param host A pointer to an @ref OFString * which should be set to the host
* of the address or NULL if the host is not needed
* @param port A pointer to an uint16_t which should be set to the port of the
* address or NULL if the port is not needed
*/
extern void of_address_to_string_and_port(struct sockaddr *address,
socklen_t addressLength,
OFString *__autoreleasing _Nonnull *_Nullable host,
uint16_t *_Nullable port);
/*!
* @brief Frees the results returned by @ref of_resolve_host.
*
* @param results The results returned by @ref of_resolve_host
*/
extern void of_resolver_free(
of_resolver_result_t *_Nullable *_Nonnull results);
#ifdef __cplusplus
}
#endif
OF_ASSUME_NONNULL_END