~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/man/memcached_pool_behavior_set.3

  • Committer: Continuous Integration
  • Date: 2012-03-14 16:53:36 UTC
  • mfrom: (990.2.1 workspace)
  • Revision ID: ci@tangent.org-20120314165336-mjrg2hwmb6sx1er2
jenkins-promote-staging-trunk-libmemcached-3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "MEMCACHED_POOL_BEHAVIOR_SET" "3" "January 26, 2012" "1.0.4" "libmemcached"
 
1
.TH "MEMCACHED_POOL_BEHAVIOR_SET" "3" "March 14, 2012" "1.0.5" "libmemcached"
2
2
.SH NAME
3
3
memcached_pool_behavior_set \- libmemcached Documentation
4
4
.
56
56
.B memcached_st* memcached_pool_pop(\fI\%memcached_pool_st\fP*\fI\ pool\fP, bool\fI\ block\fP, memcached_return_t\fI\ *rc\fP)
57
57
.UNINDENT
58
58
.sp
59
 
Deprecated since version 0.53: Use \fBmemcached_pool_fetch()\fP
 
59
Deprecated since version 0.53: Use \fI\%memcached_pool_fetch()\fP
60
60
.INDENT 0.0
61
61
.TP
62
 
.B memcached_st* memcached_pool_fetch(memcached_pool_st*, struct timespec* relative_time, memcached_return_t* rc);
 
62
.B memcached_st* memcached_pool_fetch(\fI\%memcached_pool_st\fP*, struct timespec*\fI\ relative_time\fP, memcached_return_t*\fI\ rc\fP)
63
63
.UNINDENT
64
64
.sp
65
 
New in version 0.53: Synonym for memcached_pool_pop()
 
65
New in version 0.53: Synonym for memcached_pool_pop
66
66
.INDENT 0.0
67
67
.TP
68
68
.B memcached_return_t memcached_pool_push(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st\fI\ *mmc\fP)
71
71
Deprecated since version 0.53: Use \fI\%memcached_pool_push()\fP
72
72
.INDENT 0.0
73
73
.TP
74
 
.B memcached_return_t memcached_pool_release(memcached_pool_st* pool, memcached_st* mmc);
 
74
.B memcached_return_t memcached_pool_release(\fI\%memcached_pool_st\fP*\fI\ pool\fP, memcached_st*\fI\ mmc\fP)
75
75
.UNINDENT
76
76
.sp
77
 
New in version 0.53: Synonym for memcached_pool_push().
 
77
New in version 0.53: Synonym for memcached_pool_push.
78
78
.INDENT 0.0
79
79
.TP
80
80
.B memcached_return_t memcached_pool_behavior_set(\fI\%memcached_pool_st\fP\fI\ *pool\fP, memcached_behavior_t\fI\ flag\fP, uint64_t\fI\ data\fP)
96
96
resources. It will return the pointer to the \fBmemcached_st\fP structure
97
97
passed as an argument to \fI\%memcached_pool_create()\fP, and returns the ownership of the pointer to the caller when created with \fI\%memcached_pool_create()\fP, otherwise NULL is returned..
98
98
.sp
99
 
\fBmemcached_pool_fetch()\fP is used to fetch a connection structure from the
 
99
\fI\%memcached_pool_fetch()\fP is used to fetch a connection structure from the
100
100
connection pool. The relative_time argument specifies if the function should
101
101
block and wait for a connection structure to be available if we try
102
102
to exceed the maximum size. You need to specify time in relative time.
103
103
.sp
104
 
\fBmemcached_pool_release()\fP is used to return a connection structure back to the pool.
 
104
\fI\%memcached_pool_release()\fP is used to return a connection structure back to the pool.
105
105
.sp
106
106
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_set()\fP is used to get/set behavior flags on all connections in the pool.
107
107
.sp
108
 
Both \fBmemcached_pool_release()\fP and \fBmemcached_pool_fetch()\fP are thread safe.
 
108
Both \fI\%memcached_pool_release()\fP and \fI\%memcached_pool_fetch()\fP are thread safe.
109
109
.SH RETURN
110
110
.sp
111
111
\fI\%memcached_pool_destroy()\fP returns the pointer (and ownership) to the \fBmemcached_st\fP structure used to create the pool. If connections are in use it returns NULL.
112
112
.sp
113
113
\fI\%memcached_pool_pop()\fP returns a pointer to a \fBmemcached_st\fP structure from the pool (or NULL if an allocation cannot be satisfied).
114
114
.sp
115
 
\fBmemcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
 
115
\fI\%memcached_pool_release()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
116
116
.sp
117
117
\fI\%memcached_pool_behavior_get()\fP and \fI\%memcached_pool_behavior_get()\fP returns \fBMEMCACHED_SUCCESS\fP upon success.
118
118
.sp
119
119
If any methods returns MEMCACHED_IN_PROGRESS then a lock on the pool could not be obtained. If any of the parameters passed to any of these functions is invalid, MEMCACHED_INVALID_ARGUMENTS will be returned.
120
120
.sp
121
 
memcached_pool_fetch() may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
 
121
memcached_pool_fetch may return MEMCACHED_TIMEOUT if a timeout occurs while waiting for a free memcached_st. MEMCACHED_NOTFOUND if no memcached_st was available.
122
122
.SH HOME
123
123
.sp
124
124
To find out more information please check: