debian-packages/eventcore
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

More detailed documentation for cancelConnectStream().

Browse source
This commit is contained in:
Sönke Ludwig 2017-11-12 14:34:58 +01:00
parent f146fa01f4
commit 569b75e050
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
source/eventcore/driver.d
View file

@ -128,6 +128,19 @@ interface EventDriverSockets {
StreamSocketFD connectStream(scope Address peer_address, scope Address bind_address, ConnectCallback on_connect); StreamSocketFD connectStream(scope Address peer_address, scope Address bind_address, ConnectCallback on_connect);
/** Aborts asynchronous connect by closing the socket. /** Aborts asynchronous connect by closing the socket.
This function may only invoked if the connection state is
`ConnectionState.connecting`. It will cancel the connection attempt and
guarantees that the connection callback will not be invoked in the
future.
Note that upon completion, the socket handle will be invalid, regardless
of the number of calls to `addRef`, and must not be used for further
operations.
Params:
sock = Handle of the socket that is currently establishing a
connection
*/ */
void cancelConnectStream(StreamSocketFD sock); void cancelConnectStream(StreamSocketFD sock);