Generic Function

Summary

Waits to establish a connection for a stream.

Package

win32

Signature

wait-for-connection stream &key timeout wait-reason wait-function => connectedp

Arguments

stream

A named pipe stream.

timeout

A non-negative real number, or nil.

wait-reason

A string, or nil.

wait-function

A function designator, or nil.

Values

connectedp

A generalized boolean.

Description

The function wait-for-connection waits until it succeeds to establish a connection for the stream stream, or timeout seconds passed or wait-function returns non-nil, and returns a value indicating whether the connection is established successfully.

stream must be a stream of the right type. Currently the only supported stream is a named pipe stream (the result of open-named-pipe-stream).

timeout can be nil or a real number specifying the time in seconds before wait-for-connection returns without establishing a connection.

wait-reason, if non-nil, needs to be a string specifying the wait reason. It has the same semantics as the wait-reason argument of process-wait.

wait-function, if non-nil, must be a function of no arguments. If it returns non-nil, wait-for-connection returns nil.

wait-for-connection can be repeatedly called on the same stream. If the stream has already established a connection, it returns true immediately.

Notes

wait-function has the same limitations as the wait-function of process-wait.

See also

open-named-pipe-stream