c-libp2p/include/libp2p/peer/peer.h

109 lines
3.5 KiB
C
Raw Normal View History

2017-02-20 23:53:20 +00:00
#pragma once
2017-02-27 17:27:14 +00:00
#include "multiaddr/multiaddr.h"
2017-04-03 22:26:08 +00:00
#include "libp2p/net/stream.h"
2017-02-27 17:27:14 +00:00
2017-02-20 23:53:20 +00:00
enum ConnectionType {
// sender does not have a connection to the peer, and no extra information (default)
CONNECTION_TYPE_NOT_CONNECTED = 0,
// sender has a live connection to the peer
CONNECTION_TYPE_CONNECTED = 1,
// sender recently connected to peer
CONNECTION_TYPE_CAN_CONNECT = 2,
// sender recently tried to connect to peer repeatedly but failed to connect
CONNECTION_TYPE_CANNOT_CONNECT = 3
};
struct Libp2pPeer {
2017-03-02 21:14:52 +00:00
char* id; // protobuf field 1; the ID (aka peer id) of the peer
size_t id_size; // the length of id
2017-02-20 23:53:20 +00:00
struct Libp2pLinkedList* addr_head; // protobuf field 2 of multiaddr bytes (repeatable) (stored here as a struct MultiAddr)
enum ConnectionType connection_type; // protobuf field 3 (a varint)
2017-04-03 22:26:08 +00:00
struct Stream *connection; // not protobuf'd, the current connection to the peer
2017-02-20 23:53:20 +00:00
};
/**
* create a new Peer struct
* @returns a struct or NULL if there was a problem
*/
struct Libp2pPeer* libp2p_peer_new();
2017-02-27 17:27:14 +00:00
/**
* Create a new Peer based on a multiaddress
* @param in the multiaddress
* @returns a Peer initialized with the values from "in"
2017-02-27 17:27:14 +00:00
*/
struct Libp2pPeer* libp2p_peer_new_from_multiaddress(const struct MultiAddress* multi_addr);
2017-02-27 17:27:14 +00:00
2017-02-20 23:53:20 +00:00
/**
* frees resources from a peer struct
* @param in the peer to free
*/
void libp2p_peer_free(struct Libp2pPeer* in);
2017-04-03 22:26:08 +00:00
/**
* Attempt to connect to the peer, setting connection_type correctly
* NOTE: If successful, this will set peer->connection to the stream
* @param peer the peer to connect to
* @returns true(1) on success, false(0) if we could not connect
*/
int libp2p_peer_connect(struct Libp2pPeer* peer);
2017-02-20 23:53:20 +00:00
/**
* Make a copy of a peer
* @param in what is to be copied
* @returns a new struct, that does not rely on the old
*/
struct Libp2pPeer* libp2p_peer_copy(struct Libp2pPeer* in);
/***
* Determine if the passed in peer and id match
* @param in the peer to check
* @param peer_id peer id, zero terminated string
* @returns true if peer matches
*/
int libp2p_peer_matches_id(struct Libp2pPeer* in, const unsigned char* peer_id);
/***
* Determine if we are currently connected to this peer
* @param in the peer to check
* @returns true(1) if connected
*/
int libp2p_peer_is_connected(struct Libp2pPeer* in);
2017-02-20 23:53:20 +00:00
/**
* Get an estimate of the necessary size of the buffer to protobuf a particular peer
* @param in the peer to examine
* @returns an approximation of the buffer size required (erring on the side of bigger)
*/
size_t libp2p_peer_protobuf_encode_size(struct Libp2pPeer* in);
/**
* Encode the Peer into a buffer
* @param in the peer
* @param buffer where to put it
* @param max_buffer_size the maximum amount of memory reserved for the buffer
* @param bytes_written the number of bytes written to the buffer
* @returns true(1) on success, otherwise 0
*/
int libp2p_peer_protobuf_encode(struct Libp2pPeer* in, unsigned char* buffer, size_t max_buffer_size, size_t* bytes_written);
/**
* Encode the Peer into a buffer
* @param in the peer
* @param buffer where to put it (will be allocated by this function)
* @param buffer_size the number of bytes written to the buffer
* @returns true(1) on success, otherwise 0
*/
int libp2p_peer_protobuf_encode_with_alloc(struct Libp2pPeer* in, unsigned char** buffer, size_t *buffer_size);
2017-02-20 23:53:20 +00:00
/**
* turn an array of bytes into a Peer
* @param in the protobuf formatted peer
* @param in_size the size of in
* @param out the new Peer
* @returns true(1) on success, otherwise false
*/
int libp2p_peer_protobuf_decode(unsigned char* in, size_t in_size, struct Libp2pPeer** out);