SSH.TCPTunnel.Poll

SSH.TCPTunnel.Poll

Method Signature

 Function Poll(Timeout As Integer = 1000, EventMask As Integer = -1) As Boolean

Parameters

Name	Type	Comment
Timeout	Integer	Optional. If specified, the maximum period of time to wait for activity before returning, in milliseconds.
EventMask	Integer	Optional. If specified, a bitmask of LIBSSH2_POLLFD_* constants indicating which streams to poll. If not specified then all streams are polled.

Return value

Returns True if there was activity on the tunnel before the timeout elapsed.

Remarks

Polls the tunnel for activity. If the tunnel is listening for an inbound connection then the listener is polled, in which case EventMask is ignored. If this method returns True then there was activity on the tunnel/listener.

This method will raise the Connected(), DataAvailable(), Disconnected(), and Error() events as appropriate.

See also

• TCPTunnel.Read
• Channel.Poll