bson_reader_new_from_fd(3)

NAME

bson_reader_new_from_fd() – The bson_reader_new_from_fd() function shall create a new bson_reader_t that will read from the provided file-descriptor.

SYNOPSIS

bson_reader_t *
bson_reader_new_from_fd (int  fd,
                         bool close_on_destroy);

PARAMETERS

fd

A valid file-descriptor.

close_on_destroy

Whether close(3) should be called on fd when the reader is destroyed.

DESCRIPTION

The bson_reader_new_from_fd(3) function shall create a new bson_reader_t that will read from the provided file-descriptor.

fd MUST be in blocking mode.

If close_fd is true, then fd will be closed when the bson_reader_t is destroyed with bson_reader_destroy(3) \&.

RETURNS

A newly allocated bson_reader_t that should be freed with bson_reader_destroy \&.

COLOPHON

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

Index