forked from mongodb/mongo-php-driver-legacy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cursor.h
147 lines (123 loc) · 5.39 KB
/
cursor.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/**
* Copyright 2009-2013 10gen, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MONGO_CURSOR_H
#define MONGO_CURSOR_H 1
void php_mongo_cursor_free(void *object TSRMLS_DC);
/* Tries to read the reply from the database */
int php_mongo_get_reply(mongo_cursor *cursor TSRMLS_DC);
/* Queries the database. Returns SUCCESS or FAILURE. */
int mongo_cursor__do_query(zval *this_ptr, zval *return_value TSRMLS_DC);
/* Reset the cursor to clean up or prepare for another query. Removes cursor
* from cursor list (and kills it, if necessary). */
void mongo_util_cursor_reset(mongo_cursor *cursor TSRMLS_DC);
/* Resets cursor and disconnects connection. Always returns FAILURE (so it can
* be used by functions returning FAILURE). */
int mongo_util_cursor_failed(mongo_cursor *cursor TSRMLS_DC);
/* If the query should be send to the db or not. The rules are:
* - db commands should only be sent onces (no retries)
* - normal queries should be sent up to 5 times
* This uses exponential backoff with a random seed to avoid flooding a
* struggling db with retries. */
int mongo_cursor__should_retry(mongo_cursor *cursor);
/* Kills a cursor on the server */
void php_mongo_kill_cursor(mongo_connection *con, int64_t cursor_id TSRMLS_DC);
/* Set Cursor limit */
void php_mongo_cursor_set_limit(mongo_cursor *cursor, long limit);
/* Forces the bson to zval conversion to use an object for a long */
void php_mongo_cursor_force_long_as_object(mongo_cursor *cursor);
/* Flags the cursor as a command cursor */
void php_mongo_cursor_force_command_cursor(mongo_cursor *cursor);
/* Switch to primary connection */
void php_mongo_cursor_force_primary(mongo_cursor *cursor);
/* Set a Cursor Option */
int php_mongo_cursor_add_option(mongo_cursor *cursor, char *key, zval *value TSRMLS_DC);
PHP_METHOD(MongoCursor, __construct);
PHP_METHOD(MongoCursor, getNext);
PHP_METHOD(MongoCursor, hasNext);
PHP_METHOD(MongoCursor, limit);
PHP_METHOD(MongoCursor, batchSize);
PHP_METHOD(MongoCursor, skip);
PHP_METHOD(MongoCursor, fields);
PHP_METHOD(MongoCursor, setFlag);
PHP_METHOD(MongoCursor, tailable);
PHP_METHOD(MongoCursor, slaveOkay);
PHP_METHOD(MongoCursor, immortal);
PHP_METHOD(MongoCursor, awaitData);
PHP_METHOD(MongoCursor, partial);
PHP_METHOD(MongoCursor, timeout);
PHP_METHOD(MongoCursor, dead);
PHP_METHOD(MongoCursor, snapshot);
PHP_METHOD(MongoCursor, sort);
PHP_METHOD(MongoCursor, hint);
PHP_METHOD(MongoCursor, getReadPreference);
PHP_METHOD(MongoCursor, setReadPreference);
PHP_METHOD(MongoCursor, addOption);
PHP_METHOD(MongoCursor, explain);
PHP_METHOD(MongoCursor, doQuery);
PHP_METHOD(MongoCursor, current);
PHP_METHOD(MongoCursor, key);
PHP_METHOD(MongoCursor, next);
PHP_METHOD(MongoCursor, rewind);
PHP_METHOD(MongoCursor, valid);
PHP_METHOD(MongoCursor, reset);
PHP_METHOD(MongoCursor, count);
PHP_METHOD(MongoCursor, info);
#define PREITERATION_SETUP \
PHP_MONGO_GET_CURSOR(getThis()); \
\
if (cursor->started_iterating) { \
zend_throw_exception(mongo_ce_CursorException, "cannot modify cursor after beginning iteration.", 0 TSRMLS_CC); \
return; \
}
PHP_METHOD(MongoCursorException, getHost);
/* Throw a MongoCursorException with the given code and message. Uses the
* server to fill in information about the connection that cause the exception.
* Does nothing if an exception has already been thrown. */
zval* mongo_cursor_throw(zend_class_entry *exception_ce, mongo_connection *connection, int code TSRMLS_DC, char *format, ...);
/* The cursor_list
*
* In PHP, garbage collection works via reference counting. MongoCursor
* contains a reference to its "parent" Mongo instance, so it increments the
* Mongo's reference count in the constructor.
*
* Depending on app server/code, MongoCursor could be destroyed before or after
* Mongo. If Mongo is destroyed first, we want to kill all open cursors using
* that connection before destroying the connection. So, mongo_cursor_free_le,
* when given a MONGO_LINK, will kill all cursors associated with that link.
* When given a MONGO_CURSOR, it will destroy exactly that cursor (and no
* others). This also removes it from the cursor_list. */
/* This kills a cursor or all cursors for a given link, depending on the type
* given. Also removes killed cursor(s) from the cursor_list. */
void mongo_cursor_free_le(void* val, int type TSRMLS_DC);
/* Adds a cursor to the cursor_list.
*
* A cursor can only be added once to the cursor list. If cursor is already on
* the list, this does nothing. This creates the cursor_list if it does not
* exist. */
int php_mongo_create_le(mongo_cursor *cursor, char *name TSRMLS_DC);
/* Actually removes a cursor_node node from the linked list. */
void php_mongo_free_cursor_node(cursor_node*, zend_rsrc_list_entry*);
/* Persistent list destructor. */
void php_mongo_cursor_list_pfree(zend_rsrc_list_entry* TSRMLS_DC);
#endif
/*
* Local variables:
* tab-width: 4
* c-basic-offset: 4
* End:
* vim600: fdm=marker
* vim: noet sw=4 ts=4
*/