src/libmongo-private.h File Reference

Private types and functions, for internal use in libmongo-client only. More...

#include "mongo.h"
#include "compat.h"

Include dependency graph for libmongo-private.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	bson
	An opaque BSON object. More...
struct	mongo_connection
	Opaque MongoDB connection object type. More...
struct	mongo_sync_connection
	Opaque synchronous connection object. More...
struct	mongo_sync_cursor
	Opaque Mongo Cursor object. More...
struct	mongo_sync_pool_connection
	Opaque synchronous connection pool object. More...
struct	mongo_sync_gridfs
	Opaque GridFS object. More...
struct	mongo_sync_gridfs_file_common
struct	mongo_sync_gridfs_chunked_file
	Opaque GridFS chunked file object. More...
struct	mongo_sync_gridfs_stream
	Opaque GridFS file stream object type. More...
Enumerations
enum	_mongo_gridfs_type { LMC_GRIDFS_FILE_CHUNKED, LMC_GRIDFS_FILE_STREAM_READER, LMC_GRIDFS_FILE_STREAM_WRITER }
Functions
mongo_packet *	mongo_wire_cmd_kill_cursors_va (gint32 id, gint32 n, va_list ap)
gboolean	mongo_wire_packet_get_header_raw (const mongo_packet *p, mongo_packet_header *header)
gboolean	mongo_wire_packet_set_header_raw (mongo_packet *p, const mongo_packet_header *header)

---

Detailed Description

Private types and functions, for internal use in libmongo-client only.

Definition in file libmongo-private.h.

---

Enumeration Type Documentation

enum _mongo_gridfs_type

GridFS file types.

Enumerator:

LMC_GRIDFS_FILE_CHUNKED	Chunked file.
LMC_GRIDFS_FILE_STREAM_READER	Streamed file, reader.
LMC_GRIDFS_FILE_STREAM_WRITER	Streamed file, writer.

Definition at line 114 of file libmongo-private.h.

---

Function Documentation

mongo_packet* mongo_wire_cmd_kill_cursors_va	(	gint32	id,
		gint32	n,
		va_list	ap
	)

Construct a kill cursors command, using a va_list.

Parameters:

id	is the sequence id.
n	is the number of cursors to delete.
ap	is the va_list of cursors to kill.

Note:

One must supply exaclty n number of cursor IDs.

Returns:

A newly allocated packet, or NULL on error. It is the responsibility of the caller to free the packet once it is not used anymore.

Definition at line 467 of file mongo-wire.c.

Here is the caller graph for this function:

gboolean mongo_wire_packet_get_header_raw	(	const mongo_packet *	p,
		mongo_packet_header *	header
	)

Get the header data of a packet, without conversion.

Retrieve the mongo packet's header data, but do not convert the values from little-endian. Use only when the source has the data in the right byte order already.

Parameters:

p	is the packet which header we seek.
header	is a pointer to a variable which will hold the data.

Note:

Allocating the header is the responsibility of the caller.

Returns:

TRUE on success, FALSE otherwise.

Definition at line 88 of file mongo-wire.c.

Here is the caller graph for this function:

gboolean mongo_wire_packet_set_header_raw	(	mongo_packet *	p,
		const mongo_packet_header *	header
	)

Set the header data of a packet, without conversion.

Override the mongo packet's header data, but do not convert the values from little-endian. Use only when the source has the data in the right byte order already.

Note:

No sanity checks are done, use this function with great care.

Parameters:

p	is the packet whose header we want to override.
header	is the header structure to use.

Returns:

TRUE on success, FALSE otherwise.

Definition at line 131 of file mongo-wire.c.

Here is the caller graph for this function: