c-libp2p/include/libp2p/net/stream.h

49 lines
1.3 KiB
C
Raw Normal View History

#pragma once
/**
* An interface in front of various streams
*/
struct Stream {
/**
* A generic socket descriptor
*/
void* socket_descriptor;
struct MultiAddress *address;
/**
* Reads from the stream
2017-03-30 18:58:53 +00:00
* @param stream the stream context (usually a SessionContext pointer)
* @param buffer where to put the results
* @param bytes_read how many bytes were read
* @param timeout_secs number of seconds before a timeout
* @returns true(1) on success, false(0) otherwise
*/
int (*read)(void* stream_context, unsigned char** buffer, size_t* bytes_read, int timeout_secs);
/**
* Writes to a stream
2017-08-30 16:09:28 +00:00
* @param stream the stream context (usually a SessionContext pointer)
* @param buffer what to write
* @param how much to write
* @returns true(1) on success, false(0) otherwise
*/
2017-03-09 15:00:45 +00:00
int (*write)(void* stream_context, const unsigned char* buffer, size_t buffer_size);
/**
* Closes a stream
2017-07-27 19:32:42 +00:00
*
* NOTE: This is also responsible for deallocating the Stream struct
2017-03-30 18:58:53 +00:00
* @param stream the stream context
* @returns true(1) on success, otherwise false(0)
*/
2017-03-09 15:00:45 +00:00
int (*close)(void* stream_context);
/***
* Checks to see if something is waiting on the stream
*
* @param stream the stream context
* @returns true(1) if something is waiting, false(0) otherwise
*/
int (*peek)(void* stream_context);
};