72 lines
2 KiB
C
72 lines
2 KiB
C
#pragma once
|
|
|
|
#include <pthread.h>
|
|
|
|
/**
|
|
* An interface in front of various streams
|
|
*/
|
|
struct Stream {
|
|
/**
|
|
* A generic socket descriptor
|
|
*/
|
|
void* socket_descriptor;
|
|
pthread_mutex_t socket_mutex;
|
|
struct MultiAddress *address;
|
|
|
|
/**
|
|
* Reads from the stream
|
|
* @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
|
|
* @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
|
|
*/
|
|
int (*write)(void* stream_context, const unsigned char* buffer, size_t buffer_size);
|
|
|
|
/**
|
|
* Closes a stream
|
|
*
|
|
* NOTE: This is also responsible for deallocating the Stream struct
|
|
* @param stream the stream context
|
|
* @returns true(1) on success, otherwise false(0)
|
|
*/
|
|
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);
|
|
};
|
|
|
|
/***
|
|
* Attempt to lock a stream for personal use. Does not block.
|
|
* @param stream the stream to lock
|
|
* @returns true(1) on success, false(0) otherwise
|
|
*/
|
|
int libp2p_stream_try_lock(struct Stream* stream);
|
|
|
|
/***
|
|
* Attempt to lock a stream for personal use. Blocks until the lock is acquired
|
|
* @param stream the stream to lock
|
|
* @returns true(1) on success, false(0) otherwise
|
|
*/
|
|
int libp2p_stream_lock(struct Stream* stream);
|
|
|
|
/***
|
|
* Attempt to unlock the mutex for this stream
|
|
* @param stream the stream to unlock
|
|
* @returns true(1) on success, false(0) otherwise
|
|
*/
|
|
int libp2p_stream_unlock(struct Stream* stream);
|