c-libp2p/include/libp2p/yamux/yamux.h

153 lines
5 KiB
C
Raw Normal View History

2017-10-11 16:23:25 +00:00
#pragma once
#include "libp2p/net/protocol.h"
2017-10-23 23:03:38 +00:00
#include "libp2p/net/stream.h"
2017-11-30 19:32:36 +00:00
#include "libp2p/utils/threadsafe_buffer.h"
#include "libp2p/yamux/stream.h"
2017-10-23 23:03:38 +00:00
/***
* Declarations for the Yamux protocol
*/
2017-10-11 16:23:25 +00:00
static const int yamux_default_timeout = 10;
static const char YAMUX_CONTEXT = 'Y';
static const char YAMUX_CHANNEL_CONTEXT = 'C';
struct YamuxProtocolContext {
struct Libp2pVector* protocol_handlers;
};
/***
* Context struct for Yamux
*/
struct YamuxContext {
char type;
struct Stream* stream;
struct yamux_session* session;
struct Libp2pVector* channels;
int am_server;
int state; // the state of the connection
struct Libp2pVector* protocol_handlers;
2017-11-23 11:23:50 +00:00
/**
* What is stored here is from a read_raw call. It could
* be garbage, but it could be a decent message. It has
* been "unframed" so contains the data portion of the
* last frame captured in a read_raw call, or if it was
* empty, the data from a new read call.
*/
2017-11-20 00:29:40 +00:00
struct StreamMessage* buffered_message;
long buffered_message_pos;
};
struct YamuxChannelContext {
char type;
struct YamuxContext* yamux_context;
// this stream
struct Stream* stream;
// the child protocol's stream
struct Stream* child_stream;
// the channel number
2017-11-23 11:23:50 +00:00
uint32_t channel;
// the window size for this channel
int window_size;
// the state of the connection
int state;
// whether or not the connection is closed
int closed;
2017-11-30 19:32:36 +00:00
// a buffer for data coming in from the network
struct ThreadsafeBufferContext* buffer;
// true if read is already running
int read_running;
};
2017-10-11 16:23:25 +00:00
/**
* Build a handler that can handle the yamux protocol
*/
struct Libp2pProtocolHandler* libp2p_yamux_build_protocol_handler();
2017-10-12 15:12:22 +00:00
/***
* Send the yamux protocol out the default stream
* NOTE: if we initiate the connection, we should expect the same back
* @param stream the stream
2017-10-12 15:12:22 +00:00
* @returns true(1) on success, false(0) otherwise
*/
int yamux_send_protocol(struct Stream* stream);
2017-10-12 17:37:40 +00:00
/***
* Check to see if the reply is the yamux protocol header we expect
* NOTE: if we initiate the connection, we should expect the same back
* @param context the SessionContext
* @returns true(1) on success, false(0) otherwise
*/
int yamux_receive_protocol(struct YamuxContext* context);
2017-10-23 23:03:38 +00:00
/***
* Negotiate the Yamux protocol
* @param parent_stream the parent stream
* @param am_server true(1) if we are considered the server, false(0) if we are the client.
* @param protocol_handlers the protocol handlers (used when a new protocol is requested)
* @returns a Stream initialized and ready for yamux
*/
struct Stream* libp2p_yamux_stream_new(struct Stream* parent_stream, int am_server, struct Libp2pVector* protocol_handlers);
void libp2p_yamux_stream_free(struct Stream* stream);
/****
* Add a stream "channel" to the yamux handler
* @param ctx the context
* @param stream the stream to add
* @returns true(1) on success, false(0) otherwise
*/
int libp2p_yamux_stream_add(struct YamuxContext* ctx, struct Stream* stream);
/**
* Create a stream that has a "YamuxChannelContext" related to this yamux protocol
* NOTE: If incoming_stream is not of the Yamux protocol, this "wraps" the incoming
* stream, so that the returned stream is the parent of the incoming_stream. If the
* incoming stream is of the yamux protocol, the YamuxChannelContext.child_stream
* will be NULL, awaiting an upgrade to fill it in.
* @param incoming_stream the stream of the new protocol
* @param channelNumber the channel number (0 if unknown)
* @returns a new Stream that has a YamuxChannelContext
*/
struct Stream* libp2p_yamux_channel_stream_new(struct Stream* incoming_stream, int channelNumber);
void libp2p_yamux_channel_free(struct YamuxChannelContext* ctx);
/***
* Prepare a new Yamux StreamMessage based on another StreamMessage
* NOTE: This is here for testing. This should normally not be used.
* @param incoming the incoming message
* @returns a new StreamMessage that has a yamux_frame
*/
struct StreamMessage* libp2p_yamux_prepare_to_send(struct StreamMessage* incoming);
2017-11-29 04:41:46 +00:00
/***
* Wait for yamux stream to become ready
* @param session_context the session context to check
* @param timeout_secs the number of seconds to wait for things to become ready
* @returns true(1) if it becomes ready, false(0) otherwise
*/
int libp2p_yamux_stream_ready(struct SessionContext* session_context, int timeout_secs);
/**
* Given a context, get the YamuxChannelContext
* @param stream_context the context
* @returns the YamuxChannelContext or NULL if there was none
*/
struct YamuxChannelContext* libp2p_yamux_get_channel_context(void* stream_context);
/***
* Given a context, get the YamuxContext
* @param stream_context a YamuxChannelContext or a YamuxContext
* @returns the YamuxContext, or NULL on error
*/
struct YamuxContext* libp2p_yamux_get_context(void* stream_context);
/***
* Walks down the tree, looking for the nearest YamuxChannelContext
* @param in the stream
* @returns the YamuxChannelContext or NULL
*/
struct YamuxChannelContext* libp2p_yamux_get_parent_channel_context(struct Stream* in);