← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/barriers.rst

  • Committer: pcrews
  • Date: 2011-05-24 17:36:24 UTC
  • mfrom: (1099.4.232 drizzle)
  • Revision ID: pcrews@lucid32-20110524173624-mwr1bvq6fa1r01ao
Updated translations + 2011.05.18 tarball tag

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/barriers.rst
1
1
User Defined Barriers
2
2
=====================
3
3
 
4
 
SELECT create_barrier();
5
 
 
6
 
SELECT release_barrier();
7
 
 
8
 
SELECT wait();
9
 
 
10
 
SELECT wait_until();
11
 
 
12
 
SELECT signal();
13
 
 
14
 
A barrier is a synchronization objest which can be used to syncronize a
15
 
group of sessions to a specific rendezvous by calling wait(). When wait() is called,
16
 
any session of the user may call signal(), allowing all sessions being held by wait() to proceed. 
17
 
 
18
 
Barriers can optionally be created with a limit so that once a set number of sessions have called wait() that all "waiters" are then allowed to proceed. 
19
 
 
20
 
The session that creates the barrier via create_barrier() is not allowed to
21
 
call either wait() or wait_until().
 
4
.. code-block:: mysql
 
5
 
 
6
  SELECT create_barrier();
 
7
 
 
8
  SELECT release_barrier();
 
9
 
 
10
  SELECT wait();
 
11
 
 
12
  SELECT wait_until();
 
13
 
 
14
  SELECT signal();
 
15
 
 
16
A barrier is a synchronization object which can be used to synchronize
 
17
a group of sessions to a specific rendezvous by calling wait(). When
 
18
wait() is called, any session of the user may call signal(), allowing
 
19
all sessions being held by wait() to proceed.
 
20
 
 
21
Barriers can optionally be created with a limit so that once a set
 
22
number of sessions have called wait() that all "waiters" are then
 
23
allowed to proceed.
 
24
 
 
25
The session that creates the barrier via create_barrier() is not
 
26
allowed to call either wait() or wait_until().
22
27
 
23
28
The scope of barriers is to the given username.
24
29
 
25
 
Beyond waiters, you can also create observers by using the wait_until()
26
 
function. Observers are released not only when signal() or release_barrier()
27
 
is called, but also when their definitine predicate happens. You can use
28
 
wait_until() to have a session wait for a certain number of waiters to
29
 
occur, and then do some body of work before the waiters() are signalled to
30
 
continue.
31
 
 
32
 
All waiters and observers are released if release_barrier() is called by the
33
 
session which created the barrier. Also, if the session that created the
34
 
barrier disconnects, all waiters and observers are notified.
35
 
 
36
 
Information on all barriers can be found in the DATA_DICTIONARY.USER_BARRIERS
37
 
table;
 
30
Beyond waiters, you can also create observers by using the
 
31
wait_until() function. Observers are released not only when signal()
 
32
or release_barrier() is called, but also when their definitive
 
33
predicate happens. You can use wait_until() to have a session wait for
 
34
a certain number of waiters to occur, and then do some body of work
 
35
before the waiters() are signaled to continue.
 
36
 
 
37
All waiters and observers are released if release_barrier() is called
 
38
by the session which created the barrier. Also, if the session that
 
39
created the barrier disconnects, all waiters and observers are
 
40
notified.
 
41
 
 
42
Information on all barriers can be found in the DATA_DICTIONARY.USER_BARRIERS table.
 
43