123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321 |
- /*
- This file is part of GNUnet.
- Copyright (C) 2010-2015 GNUnet e.V.
- GNUnet is free software: you can redistribute it and/or modify it
- under the terms of the GNU Affero General Public License as published
- by the Free Software Foundation, either version 3 of the License,
- or (at your option) any later version.
- GNUnet 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
- Affero General Public License for more details.
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
- SPDX-License-Identifier: AGPL3.0-or-later
- */
- /**
- * @file transport/gnunet-service-transport_neighbours.h
- * @brief neighbour management API
- * @author Christian Grothoff
- */
- #ifndef GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
- #define GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
- #include "gnunet_statistics_service.h"
- #include "gnunet_transport_service.h"
- #include "gnunet_transport_plugin.h"
- #include "gnunet-service-transport.h"
- #include "transport.h"
- #include "gnunet_util_lib.h"
- /**
- * Initialize the neighbours subsystem.
- *
- * @param max_fds maximum number of fds to use
- */
- void
- GST_neighbours_start (unsigned int max_fds);
- /**
- * Cleanup the neighbours subsystem.
- */
- void
- GST_neighbours_stop (void);
- /**
- * Test if we're connected to the given peer.
- *
- * @param target peer to test
- * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
- */
- int
- GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
- /**
- * Function called after the transmission is done.
- *
- * @param cls closure
- * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
- * @param bytes_payload how much payload was transmitted
- * @param bytes_on_wire how many bytes were used on the wire
- */
- typedef void
- (*GST_NeighbourSendContinuation) (void *cls,
- int success,
- size_t bytes_payload,
- size_t bytes_on_wire);
- /**
- * Transmit a message to the given target using the active connection.
- *
- * @param target destination
- * @param msg message to send
- * @param msg_size number of bytes in @a msg
- * @param timeout when to fail with timeout
- * @param cont function to call when done
- * @param cont_cls closure for @a cont
- */
- void
- GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
- const void *msg,
- size_t msg_size,
- struct GNUNET_TIME_Relative timeout,
- GST_NeighbourSendContinuation cont, void *cont_cls);
- /**
- * We have received a message from the given sender.
- * How long should we delay before receiving more?
- * (Also used to keep the peer marked as live).
- *
- * @param sender sender of the message
- * @param size size of the message
- * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
- * #GNUNET_NO if the neighbour is not connected or violates the quota
- * @return how long to wait before reading more from this sender
- */
- struct GNUNET_TIME_Relative
- GST_neighbours_calculate_receive_delay (const struct
- GNUNET_PeerIdentity *sender,
- ssize_t size,
- int *do_forward);
- /**
- * Keep the connection to the given neighbour alive longer,
- * we received a KEEPALIVE (or equivalent); send a response.
- *
- * @param neighbour neighbour to keep alive (by sending keep alive response)
- * @param m the keep alive message containing the nonce to respond to
- */
- void
- GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
- const struct GNUNET_MessageHeader *m);
- /**
- * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
- * latency to this peer. Pass the updated information (existing ats
- * plus calculated latency) to ATS.
- *
- * @param neighbour neighbour to keep alive
- * @param m the message containing the keep alive response
- */
- void
- GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
- const struct GNUNET_MessageHeader *m);
- /**
- * If we have an active connection to the given target, it must be shutdown.
- *
- * @param target peer to disconnect from
- */
- void
- GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
- /**
- * Function called for each neighbour.
- *
- * @param cls closure
- * @param peer identity of the neighbour
- * @param address the address of the neighbour
- * @param state current state the peer is in
- * @param state_timeout timeout for this state
- * @param bandwidth_in inbound quota in NBO
- * @param bandwidth_out outbound quota in NBO
- */
- typedef void
- (*GST_NeighbourIterator) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_HELLO_Address *address,
- enum GNUNET_TRANSPORT_PeerState state,
- struct GNUNET_TIME_Absolute state_timeout,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
- /**
- * Iterate over all connected neighbours.
- *
- * @param cb function to call
- * @param cb_cls closure for @a cb
- */
- void
- GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
- /**
- * A session was terminated. Take note.
- *
- * @param peer identity of the peer where the session died
- * @param session session that is gone
- * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
- * this session was not in use
- */
- int
- GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
- struct GNUNET_ATS_Session *session);
- /**
- * Track information about data we received from the
- * given address (used to notify ATS about our utilization
- * of allocated resources).
- *
- * @param address the address we got data from
- * @param message the message we received (really only the size is used)
- */
- void
- GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
- const struct GNUNET_MessageHeader *message);
- /**
- * Track information about data we transmitted using the given @a
- * address and @a session (used to notify ATS about our utilization of
- * allocated resources).
- *
- * @param address the address we transmitted data to
- * @param session session we used to transmit data
- * @param message the message we sent (really only the size is used)
- */
- void
- GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
- struct GNUNET_ATS_Session *session,
- size_t size);
- /**
- * For an existing neighbour record, set the active connection to
- * use the given address.
- *
- * @param address address of the other peer to start using
- * @param session session to use (or NULL)
- * @param bandwidth_in inbound quota to be used when connection is up
- * @param bandwidth_out outbound quota to be used when connection is up
- */
- void
- GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
- struct GNUNET_ATS_Session *session,
- struct GNUNET_BANDWIDTH_Value32NBO
- bandwidth_in,
- struct GNUNET_BANDWIDTH_Value32NBO
- bandwidth_out);
- /**
- * We received a 'SESSION_CONNECT' message from the other peer.
- * Consider switching to it.
- *
- * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
- * @param peer identity of the peer to switch the address for
- * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
- */
- int
- GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
- const struct GNUNET_PeerIdentity *peer);
- /**
- * We received a 'SESSION_CONNECT_ACK' message from the other peer.
- * Consider switching to it.
- *
- * @param message possibly a `struct GNUNET_ATS_SessionConnectMessage` (check format)
- * @param address address of the other peer
- * @param session session to use (or NULL)
- * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
- */
- int
- GST_neighbours_handle_session_syn_ack (const struct
- GNUNET_MessageHeader *message,
- const struct
- GNUNET_HELLO_Address *address,
- struct GNUNET_ATS_Session *session);
- /**
- * We received a 'SESSION_ACK' message from the other peer.
- * If we sent a 'CONNECT_ACK' last, this means we are now
- * connected. Otherwise, do nothing.
- *
- * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
- * @param address address of the other peer
- * @param session session to use (or NULL)
- * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
- */
- int
- GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
- const struct GNUNET_HELLO_Address *address,
- struct GNUNET_ATS_Session *session);
- /**
- * Obtain current address information for the given neighbour.
- *
- * @param peer
- * @return address currently used
- */
- const struct GNUNET_HELLO_Address *
- GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
- /**
- * We received a quoat message from the given peer,
- * validate and process.
- *
- * @param peer sender of the message
- * @param msg the quota message
- */
- void
- GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_MessageHeader *msg);
- /**
- * We received a disconnect message from the given peer,
- * validate and process.
- *
- * @param peer sender of the message
- * @param msg the disconnect message
- */
- void
- GST_neighbours_handle_disconnect_message (const struct
- GNUNET_PeerIdentity *peer,
- const struct
- GNUNET_MessageHeader *msg);
- #endif
- /* end of file gnunet-service-transport_neighbours.h */
|