diff options
Diffstat (limited to 'Source/charon/network/host.h')
-rw-r--r-- | Source/charon/network/host.h | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/Source/charon/network/host.h b/Source/charon/network/host.h new file mode 100644 index 000000000..f592e67eb --- /dev/null +++ b/Source/charon/network/host.h @@ -0,0 +1,120 @@ +/** + * @file host.h + * + * @brief host object, identifies a host and defines some useful functions on it. + * + */ + +/* + * Copyright (C) 2005 Jan Hutter, Martin Willi + * Hochschule fuer Technik Rapperswil + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY + * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * for more details. + */ + +#ifndef HOST_H_ +#define HOST_H_ + +#include <stdlib.h> +#include <stdio.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <netinet/in.h> +#include <arpa/inet.h> + +#include <types.h> + +/** + * @brief The logger object + */ +typedef struct host_s host_t; +struct host_s { + /** + * @brief Build a clone of this host object. + * + * @param this object to clone + * @param [out]other address where to allocate the clone + * @return + * - SUCCESS, or + * - OUT_OF_RES + */ + + status_t (*clone) (host_t *this, host_t **other); + /** + * @brief Get a pointer to the internal sockaddr struct. + * + * This is used for sending and receiving via sockets. + * + * @param this object to clone + * @return pointer to the internal sockaddr structure + */ + sockaddr_t *(*get_sockaddr) (host_t *this); + + /** + * @brief Get the length of the sockaddr struct. + * + * Sepending on the family, the length of the sockaddr struct + * is different. Use this function to get the length of the sockaddr + * struct returned by get_sock_addr. + * + * This is used for sending and receiving via sockets. + * + * @param this object to clone + * @return length of the sockaddr struct + */ + socklen_t *(*get_sockaddr_len) (host_t *this); + + /** + * @brief get the address of this host + * + * Mostly used for debugging purposes. + * @warging string must NOT be freed + * + * @param this object to clone + * @return address string, + */ + char* (*get_address) (host_t *this); + + /** + * @brief get the port of this host + * + * Mostly used for debugging purposes. + * + * @param this object to clone + * @return port number + */ + u_int16_t (*get_port) (host_t *this); + + /** + * @brief Destroy this host object + * + * @param this calling + * @return SUCCESS in any case + */ + status_t (*destroy) (host_t *this); +}; + +/** + * @brief Constructor to create a host_t object + * + * currently supports only IPv4! + * + * @param family Address family to use for this object, such as AF_INET or AF_INET6 + * @param address string of an address, such as "152.96.193.130" + * @param port port number + * @return the host_t object or NULL, when + * not enough ressources, or + * family not supported. + */ +host_t *host_create(int family, char *address, u_int16_t port); + + +#endif /*HOST_H_*/ |