neocomm/include/nodes.h
Nicolás A. Ortega da483c5ba4
Added new interfaces.
I also optimized the node list a bit so as not to use more processing
power than necessary.
2017-07-02 12:09:49 +02:00

77 lines
2.4 KiB
C

/*
* Copyright (C) 2017 Ortega Froysa, Nicolás <deathsbreed@themusicinnoise.net>
* Author: Ortega Froysa, Nicolás <deathsbreed@themusicinnoise.net>
*
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later version.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*/
#pragma once
/**
* @brief Initialize the node list.
* @details This function allocates memory and prepares the nodes list, you
* must run this before using any other node related functions.
*
* @param max_nodes Maximum number of nodes available.
*
* @return If the operation failed then it will return 0, else it will
* return 1.
*/
int NeoComm_init_nodes(unsigned int max_nodes);
/**
* @brief Enlarge the list.
*
* @param new_max_nodes New number of maximum nodes.
*
* @return If the new size is less than or equal to the current size, or
* the list failed to be reallocated, then it returns 0, else it returns 1.
*/
int NeoComm_resize_node_list(unsigned int new_max_nodes);
/**
* @brief Get the maximum number of nodes that can be used.
*
* @return The maximum number of nodes that can be used..
*/
unsigned int NeoComm_get_node_max();
/**
* @brief Get the number of nodes there currently are.
*
* @return The number of nodes remembered.
*/
unsigned int NeoComm_get_node_count();
/**
* @brief Add a new node to the list with an address (normally IP) and port.
*
* @param addr Address of the new node (normally an IP, but also DNS).
* @param port Port number for new node.
*
* @return If the node list is full it will return 0, else 1.
*/
int NeoComm_add_node(char *addr, unsigned short port);
/**
* @brief Remove a node from the list.
*
* @param addr The address of the node.
* @param port The public port of the node.
*
* @return If the node was not found it returns 0, else it returns 1.
*/
int NeoComm_remove_node(char *addr, unsigned short port);