[This is preliminary documentation and is subject to change.]
Signals this Sync object with a particular object to pass.
Declaration Syntax
C# |
public void Signal( Object toPass )
Parameters
- toPass (Object)
- The object to pass to the waiting thread.
Remarks
If another thread is waiting on this Sync, this sets the sync to
complete and releases that thread. If no other thread is waiting - the
Sync is in the ready state - then the sync is set to signalled, and the
next wait on the key will not block. If the Sync is already in the
signalled state or is complete, an exception is generated. If the Sync has
timed out, no action is taken. The passed object is stored in the Sync and
will be returned to the Wait caller.
Exceptions
Exception | Condition |
---|---|
InvalidOperationException | Thrown if the Sync state is
either complete or signalled. |