upstream/openldap
1
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2026-02-03 20:40:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

ITS#7125 Document connection loop API.

Browse source 
Code comments belong in the code, not in commit messages.
This commit is contained in:
Hallvard Furuseth 2012-01-24 00:47:48 +01:00
parent 23f3657807
commit 2b538761e9
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
servers/slapd/connection.c
View file

@ -864,6 +864,17 @@ unsigned long connections_nextid(void)
return id;
}
/*
* Loop through the connections:
*
* for (c = connection_first(&i); c; c = connection_next(c, &i)) ...;
* connection_done(c);
*
* 'i' is the cursor, initialized by connection_first().
* 'c_mutex' is locked in the returned connection. The functions must
* be passed the previous return value so they can unlock it again.
*/
Connection* connection_first( ber_socket_t *index )
{
assert( connections != NULL );
@ -880,6 +891,7 @@ Connection* connection_first( ber_socket_t *index )
return connection_next(NULL, index);
}
/* Next connection in loop, see connection_first() */
Connection* connection_next( Connection *c, ber_socket_t *index )
{
assert( connections != NULL );
@ -928,6 +940,7 @@ Connection* connection_next( Connection *c, ber_socket_t *index )
return c;
}
/* End connection loop, see connection_first() */
void connection_done( Connection *c )
{
assert( connections != NULL );