SYNOPSIS

void
mongoc_cursor_get_host (mongoc_cursor_t    *cursor,
                        mongoc_host_list_t *host);

DESCRIPTION

The mongoc_cursor_get_host() function shall set host with values from the host the cursor is currently connected to.

host is a shallow copy of the underlying cluster host and does not need any clean up.

For more on the layout of the host see mongoc_client_set_stream_initiator(3).

It is a programming error to call this function on a cursor before calling mongoc_cursor_next(3). Cursors are lazily loaded, so early calls simply do nothing, as there is no host to pass back.

RETURN VALUE

The mongoc_cursor_get_host() function has no return value.

ERRORS

No errors are defined.

SEE ALSO

AUTHORS

This page was written by MongoDB Inc.