diff options
| author | Thomas Quinot <quinot@adacore.com> | 2009-04-20 08:45:04 +0000 |
|---|---|---|
| committer | Arnaud Charlet <charlet@gcc.gnu.org> | 2009-04-20 10:45:04 +0200 |
| commit | efec4f2a560b7b903f74ae8dbe98716f8e39587d (patch) | |
| tree | fc382a702dfc09387fc38d42da9d862f5d47a3e5 | |
| parent | 162f2c72380dca95a060f4cf47ae3522fd213f53 (diff) | |
| download | gcc-efec4f2a560b7b903f74ae8dbe98716f8e39587d.zip gcc-efec4f2a560b7b903f74ae8dbe98716f8e39587d.tar.gz gcc-efec4f2a560b7b903f74ae8dbe98716f8e39587d.tar.bz2 | |
g-socket.ads (Abort_Selector): Clarify documentation.
2009-04-20 Thomas Quinot <quinot@adacore.com>
* g-socket.ads (Abort_Selector): Clarify documentation.
From-SVN: r146373
| -rw-r--r-- | gcc/ada/ChangeLog | 4 | ||||
| -rw-r--r-- | gcc/ada/g-socket.ads | 16 |
2 files changed, 13 insertions, 7 deletions
diff --git a/gcc/ada/ChangeLog b/gcc/ada/ChangeLog index 99f5be0..ce73813 100644 --- a/gcc/ada/ChangeLog +++ b/gcc/ada/ChangeLog @@ -1,3 +1,7 @@ +2009-04-20 Thomas Quinot <quinot@adacore.com> + + * g-socket.ads (Abort_Selector): Clarify documentation. + 2009-04-20 Arnaud Charlet <charlet@adacore.com> * opt.ads (Inspector_Mode): Update documentation of this flag. diff --git a/gcc/ada/g-socket.ads b/gcc/ada/g-socket.ads index 009f567..882a31a 100644 --- a/gcc/ada/g-socket.ads +++ b/gcc/ada/g-socket.ads @@ -1038,13 +1038,15 @@ package GNAT.Sockets is -- that it does not watch for exception events. Note that on some -- platforms it is kept process blocking on purpose. The timeout parameter -- allows the user to have the behaviour he wants. Abort_Selector allows - -- to abort safely a Check_Selector that is blocked forever. A special - -- file descriptor is opened by Create_Selector and included in each call - -- to Check_Selector. Abort_Selector causes an event to occur on this - -- descriptor in order to unblock Check_Selector. The user must call - -- Close_Selector to discard this special file. A reason to abort a select - -- operation is typically to add a socket in one of the socket sets when - -- the timeout is set to forever. + -- to safely abort a blocked Check_Selector call. A special socket + -- is opened by Create_Selector and included in each call to + -- Check_Selector. Abort_Selector causes an event to occur on this + -- descriptor in order to unblock Check_Selector. Note that each call to + -- Abort_Selector will cause exactly one call to Check_Selector to return + -- with Aborted status. The special socket created by Create_Selector is + -- closed when Close_Selector is called. + -- A typical case where it is useful to abort a Check_Selector operation is + -- the situation where a change to the monitored sockets set must be made. procedure Create_Selector (Selector : out Selector_Type); -- Create a new selector |