stream.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <uv.h>
#include "nvim/event/loop.h"
#include "nvim/rbuffer.h"

Go to the source code of this file.

Data Structures
struct	stream

Typedefs
typedef struct stream	Stream
typedef void(*	stream_read_cb) (Stream *stream, RBuffer *buf, size_t count, void *data, bool eof)
typedef void(*	stream_write_cb) (Stream *stream, void *data, int status)
typedef void(*	stream_close_cb) (Stream *stream, void *data)

Typedef Documentation

Stream

typedef struct stream Stream

stream_close_cb

typedef void(* stream_close_cb) (Stream *stream, void *data)

stream_read_cb

typedef void(* stream_read_cb) (Stream *stream, RBuffer *buf, size_t count, void *data, bool eof)

Type of function called when the Stream buffer is filled with data

Parameters

stream	The Stream instance
buf	The associated RBuffer instance
count	Number of bytes that was read.
data	User-defined data
eof	If the stream reached EOF.

stream_write_cb

typedef void(* stream_write_cb) (Stream *stream, void *data, int status)

Type of function called when the Stream has information about a write request.

Parameters

stream	The Stream instance
data	User-defined data
status	0 on success, anything else indicates failure