This repository was archived by the owner on Feb 1, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 327
/
Copy pathfunction.log-killcursor.html
107 lines (84 loc) · 3.93 KB
/
function.log-killcursor.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Callback When Executing KILLCURSOR operations</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />
</head>
<body class="docs"><div class="navbar navbar-fixed-top">
<div class="navbar-inner clearfix">
<ul class="nav" style="width: 100%">
<li style="float: left;"><a href="function.log-getmore.html">« log_getmore</a></li>
<li style="float: right;"><a href="function.log-reply.html">log_reply »</a></li>
</ul>
</div>
</div>
<div id="breadcrumbs" class="clearfix">
<ul class="breadcrumbs-container">
<li><a href="index.html">PHP Manual</a></li>
<li><a href="mongo.context.html">Stream Context Options</a></li>
<li>Callback When Executing KILLCURSOR operations</li>
</ul>
</div>
<div id="layout">
<div id="layout-content"><div id="function.log-killcursor" class="refentry">
<div class="refnamediv">
<h1 class="refname">log_killcursor</h1>
<p class="verinfo">(PECL mongo >= 1.5.0)</p><p class="refpurpose"><span class="refname">log_killcursor</span> — <span class="dc-title">Callback When Executing KILLCURSOR operations</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.log-killcursor-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>log_killcursor</strong></span>(<span class="methodparam"><span class="type">array</span> <code class="parameter">$server</code></span>, <span class="methodparam"><span class="type">array</span> <code class="parameter">$info</code></span>)</div>
<p class="para rdfs-comment">
A <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> function, used by the
<a href="" class="link">log_killcursor context option</a>,
when reading a killcursor from MongoDB.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This is <em class="emphasis">not</em> a real function, only a prototype of how the function should
be.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.log-killcursor-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">server</code> </dt>
<dd>
<p class="para"> An array containing the basic information about the server that was picked. <table class="doctable informaltable"> <thead> <tr> <th>key</th> <th>value</th> </tr>
</thead>
<tbody class="tbody"> <tr> <td>hash</td> <td>server hash, example: <code class="literal">localhost:27017;-;X;56052</code></td> </tr>
<tr> <td>type</td> <td>Node type (primary/secondary/mongos/arbiter): <code class="literal">2</code></td> </tr>
<tr> <td>max_bson_size</td> <td>The maximum BSON Size over the wire this node accepts: <code class="literal">16777216</code></td> </tr>
<tr> <td>max_message_size</td> <td>The maximum Message Size over the wire this node accepts: <code class="literal">48000000</code></td> </tr>
<tr> <td>request_id</td> <td>The request identifier for this message: <code class="literal">42</code></td> </tr>
</tbody> </table>
</p> </dd>
<dt>
<code class="parameter">info</code>
</dt>
<dd>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>key</th>
<th>value</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>cursor_id</td>
<td>integer, the cursor identifier to kill</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dl>
</div>
</div></div></div></body></html>