mongoc_stream_t (3) - Linux Manuals

mongoc_stream_t: typedef struct _mongoc_stream_t mongoc_stream_t

NAME

mongoc_stream_t - typedef struct _mongoc_stream_t mongoc_stream_t

SYNOPSIS

typedef struct _mongoc_stream_t mongoc_stream_t

mongoc_stream_t provides a generic streaming IO abstraction based on a struct of pointers interface. The idea is to allow wrappers, perhaps other language drivers, to easily shim their IO system on top of mongoc_stream_t \&.

The API for the stream abstraction is currently private and non-extensible.

STREAM TYPES

There are a number of built in stream types that come with mongoc. The default configuration is a buffered unix stream. If SSL is in use, that in turn is wrapped in a tls stream.

COLOPHON

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

SEE ALSO

Pages related to mongoc_stream_t

  • mongoc_stream_tls_check_cert (3) - The mongoc_stream_tls_check_cert() function shall perform a RFC-6125 certificate verification.
  • mongoc_stream_tls_do_handshake (3) - This function shall perform an SSL handshake on the underlying stream.
  • mongoc_stream_tls_new (3) - Creates a new mongoc_stream_tls_t using the parameters supplied.
  • mongoc_stream_tls_t (3) - typedef struct _mongoc_stream_tls_t mongoc_stream_tls_t
  • mongoc_stream_buffered_new (3) - This function shall create a new mongoc_stream_t that buffers bytes to and from the underlying base_stream.
  • mongoc_stream_buffered_t (3) - mongoc_stream_buffered_t should be considered a subclass of mongoc_stream_t. It performs buffering on an underlying stream.
  • mongoc_stream_close (3) - This function shall close underlying file-descriptors of stream.
  • mongoc_stream_cork (3) - This function shall prevent the writing of bytes to the underlying socket.
  • mongoc_stream_destroy (3) - This function shall release all resources associated with a mongoc_stream_t, including freeing the structure. It is invalid to use stream after calling this function.
  • mongoc_stream_file_get_fd (3) - This function shall return the underlying file-descriptor of a mongoc_stream_file_t.
  • mongoc_stream_file_new (3) - Creates a new mongoc_stream_file_t using the file-descriptor provided.
  • mongoc_stream_file_new_for_path (3) - This function shall create a new mongoc_stream_file_t after opening the underlying file with open() or the platform equivalent.
  • mongoc_stream_file_t (3) - typedef struct _mongoc_stream_file_t mongoc_stream_file_t
  • mongoc_stream_flush (3) - This function shall flush any buffered bytes in the underlying stream to the physical transport. It mimics the API and semantics of fflush(), forcing a write of user space buffered data.
  • mongoc_stream_get_base_stream (3) - This function shall fetch the underlying stream for streams that wrap a base stream. Such implementations include mongoc_stream_buffered_t and mongoc_stream_tls_t.
  • mongoc_stream_gridfs_new (3) - This function shall create a new mongoc_gridfs_file_t. This function does not transfer ownership of file. Therefore, file must remain valid for the lifetime of this stream.
  • mongoc_stream_gridfs_t (3) - typedef struct _mongoc_stream_gridfs_t mongoc_stream_gridfs_t
  • mongoc_stream_read (3) - The mongoc_stream_read() function shall perform a read from a mongoc_stream_t. It's modeled on the API and semantics of read(), though the parameters map only loosely.