fune/docs/nspr/reference/pr_connectcontinue.rst

59 lines
1.5 KiB
ReStructuredText
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

PR_ConnectContinue
==================
.. _Syntax:
Syntax
------
.. code:: eval
#include <prio.h>
PRStatus PR_ConnectContinue(
PRFileDesc *fd,
PRInt16 out_flags);
.. _Parameters:
Parameters
~~~~~~~~~~
The function has the following parameters:
``fd``
A pointer to a :ref:`PRFileDesc` object representing a socket.
``out_flags``
The out_flags field of the poll descriptor returned by
`PR_Poll() <PR_Poll>`__.
.. _Returns:
Returns
~~~~~~~
- If the nonblocking connect has successfully completed,
PR_ConnectContinue returns PR_SUCCESS.
- If PR_ConnectContinue() returns PR_FAILURE, call PR_GetError():
     - PR_IN_PROGRESS_ERROR: the nonblocking connect is still in
progress and has not completed yet. The caller should poll the file
descriptor for the in_flags PR_POLL_WRITE|PR_POLL_EXCEPT and retry
PR_ConnectContinue later when PR_Poll() returns.
     - Other errors: the nonblocking connect has failed with this
error code.
.. _Description:
Description
-----------
Continue a nonblocking connect. After a nonblocking connect is initiated
with PR_Connect() (which fails with PR_IN_PROGRESS_ERROR), one should
call PR_Poll() on the socket, with the in_flags PR_POLL_WRITE \|
PR_POLL_EXCEPT. When PR_Poll() returns, one calls PR_ConnectContinue()
on the socket to determine whether the nonblocking connect has completed
or is still in progress. Repeat the PR_Poll(), PR_ConnectContinue()
sequence until the nonblocking connect has completed.