Linux Manuals

mongoc_stream_file_new() – Creates a new mongoc_stream_file_t using the file-descriptor provided. Synopsismongoc_stream_t * mongoc_stream_file_new (int fd);Parametersfd A UNIX style file-descriptor. Creates a new mongoc_stream_file_t using the file-descriptor provided. ReturnsNULL upon failure, otherwise a newly allocated mongoc_stream_file_t that should be freed with mongoc_stream_destroy(3) when no longer in use. errno is set upon failure. ColophonThis page is part…

mongoc_stream_file_get_fd() – This function shall return the underlying file-descriptor of a mongoc_stream_file_t. Synopsisint mongoc_stream_file_get_fd (mongoc_stream_file_t *stream);Parametersstream A mongoc_stream_file_t \&. This function shall return the underlying file-descriptor of a mongoc_stream_file_t \&. NOTE Performing operations on the underlying file-descriptor may not be safe if used in conjunction with buffering. Avoid reading or writing from this file-descriptor.ReturnsA file-descriptor…

mongoc_stream_destroy() – 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. Synopsisvoid mongoc_stream_destroy (mongoc_stream_t *stream);Parametersstream A mongoc_stream_t \&. This function shall release all resources associated with a mongoc_stream_t , including freeing the structure. It is invalid to use stream after…

mongoc_stream_cork() – This function shall prevent the writing of bytes to the underlying socket. Synopsisint mongoc_stream_cork (mongoc_stream_t *stream);Parametersstream A mongoc_stream_t \&. This function shall prevent the writing of bytes to the underlying socket. NOTE Not all streams implement this function. Buffering generally works better.Returns0 on success, -1 on failure and errno is set. See Alsomongoc_stream_buffered_new(3)…

mongoc_stream_close() – This function shall close underlying file-descriptors of stream. Synopsisint mongoc_stream_close (mongoc_stream_t *stream);Parametersstream A mongoc_stream_t \&. This function shall close underlying file-descriptors of stream \&. Returns0 on success, otherwise -1 and errno is set. See Alsomongoc_stream_destroy(3) ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_stream_buffered_t – mongoc_stream_buffered_t should be considered a subclass of mongoc_stream_t. It performs buffering on an underlying stream. Synopsistypedef struct _mongoc_stream_buffered_t mongoc_stream_buffered_t;Descriptionmongoc_stream_buffered_t should be considered a subclass of mongoc_stream_t \&. It performs buffering on an underlying stream. See Alsomongoc_stream_buffered_new(3) mongoc_stream_destroy(3) ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_stream_buffered_new() – This function shall create a new mongoc_stream_t that buffers bytes to and from the underlying base_stream. Synopsismongoc_stream_t * mongoc_stream_buffered_new (mongoc_stream_t *base_stream, size_t buffer_size);Parametersbase_stream A mongoc_stream_t to buffer.buffer_size A size_t containing the desired buffer size. This function shall create a new mongoc_stream_t that buffers bytes to and from the underlying base_stream \&. buffer_size will…

mongoc_ssl_opt_t – typedef struct { const char *pem_file; const char *pem_pwd; const char *ca_file; const char *ca_dir; const char *crl_file; bool        weak_cert_validation; void       *padding [8]; } mongoc_ssl_opt_t; Synopsistypedef struct { const char *pem_file; const char *pem_pwd; const char *ca_file; const char *ca_dir; const char *crl_file; bool weak_cert_validation; void *padding [8]; } mongoc_ssl_opt_t;DescriptionThis structure is used to set the SSL options for a mongoc_client_t…

mongoc_ssl_opt_get_default() – None Synopsisconst mongoc_ssl_opt_t * mongoc_ssl_opt_get_default (void) BSON_GNUC_CONST;ReturnsReturns the default SSL options for the process. This should not be modified or freed. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_socket_t – Portable socket abstraction Synopsis#include <mongoc.h> typedef struct _mongoc_socket_t mongoc_socket_tSynopsisThis structure provides a socket abstraction that is friendlier for portability than BSD sockets directly. Inconsistencies between Linux, various BSDs, Solaris, and Windows are handled here. ColophonThis page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

mongoc_socket_setsockopt() – This is a helper function for setsockopt(). Synopsisint mongoc_socket_setsockopt (mongoc_socket_t *sock, int level, int optname, const void *optval, socklen_t optlen);Parameterssock A mongoc_socket_t \&.level A sockopt level.optname A sockopt name.optval A the value for the sockopt.optlen A socklen_t that contains the length of optval.DescriptionThis is a helper function for setsockopt(3) \&. Returns0 on success,…

mongoc_socket_sendv() – Sends a vector of buffers to the destination. This uses sendmsg() when available to perform a gathered write. If IOV_MAX is reached, a fallback will be used. Synopsisssize_t mongoc_socket_sendv (mongoc_socket_t *sock, mongoc_iovec_t *iov, size_t iovcnt, int64_t expire_at);Parameterssock A mongoc_socket_t \&.iov A mongoc_iovec_t.iovcnt A size_t containing the number of elements in iov.expire_at A int64_t…

mongoc_socket_send() – Sends buflen bytes in buf to the destination. If a timeout expired, the number of bytes sent will be returned or -1 if no bytes were sent. Synopsisssize_t mongoc_socket_send (mongoc_socket_t *sock, const void *buf, size_t buflen, int64_t expire_at);Parameterssock A mongoc_socket_t \&.buf A buffer to send.buflen A size_t with the number of bytes in…

mongoc_socket_recv() – This function performs a recv() on the underlying socket. Synopsisssize_t mongoc_socket_recv (mongoc_socket_t *sock, void *buf, size_t buflen, int flags, int64_t expire_at);Parameterssock A mongoc_socket_t \&.buf A buffer to read into.buflen A size_t with the number of bytes to receive.flags flags for recv(3) \&.expire_at A int64_t with the time to expire in monotonic time using…

mongoc_socket_new() – Creates a new mongoc_socket_t structure. This calls socket() underneath to create a network socket. Synopsismongoc_socket_t * mongoc_socket_new (int domain, int type, int protocol);Parametersdomain An int containing the address family such as AF_INET.type An int containing the socket type such as SOCK_STREAM.protocol A protocol subset, typically 0.DescriptionCreates a new mongoc_socket_t structure. This calls socket(3)…

mongoc_socket_listen() – This function is similar to the BSD sockets listen() function. It is meant for socket servers. Synopsisint mongoc_socket_listen (mongoc_socket_t *sock, unsigned int backlog);Parameterssock A mongoc_socket_t \&.backlog An int containing max backlog size.DescriptionThis function is similar to the BSD sockets listen(3) function. It is meant for socket servers. Returns0 on success, -1 on failure…

mongoc_socket_getsockname() – Retrieves the socket name for sock. The result is stored in addr. addrlen should be the size of the addr when calling this. Synopsisint mongoc_socket_getsockname (mongoc_socket_t *sock, struct sockaddr *addr, socklen_t *addrlen);Parameterssock A mongoc_socket_t \&.addr A struct sockaddr.addrlen A socklen_t.DescriptionRetrieves the socket name for sock \&. The result is stored in addr \&….

mongoc_socket_getnameinfo() – This is a helper around getting the local name of a socket. It is a wrapper around getpeername() and getnameinfo(). Synopsischar * mongoc_socket_getnameinfo (mongoc_socket_t *sock);Parameterssock A mongoc_socket_t \&.DescriptionThis is a helper around getting the local name of a socket. It is a wrapper around getpeername(3) and getnameinfo(3) \&. ReturnsA newly allocated string that…

mongoc_socket_errno() – This function returns the currently captured errno for a socket. This may be useful to check was the last errno was after another function call has been made that clears the threads errno variable. Synopsisint mongoc_socket_errno (mongoc_socket_t *sock);Parameterssock A mongoc_socket_t \&.DescriptionThis function returns the currently captured errno for a socket. This may be…

mongoc_socket_destroy() – This function releases all resources associated with a mongoc_socket_t. This should be called when you are no longer using the socket. Synopsisvoid mongoc_socket_destroy (mongoc_socket_t *sock);Parameterssock A mongoc_socket_t \&.DescriptionThis function releases all resources associated with a mongoc_socket_t \&. This should be called when you are no longer using the socket. ColophonThis page is part…