libssh2/docs/libssh2_session_get_timeout.md

c, SPDX-License-Identifier, Title, Section, Source, See-also

c	SPDX-License-Identifier	Title	Section	Source	See-also
Copyright (C) The libssh2 project and its contributors.	BSD-3-Clause	libssh2_session_get_timeout	3	libssh2	libssh2_session_set_timeout(3)

NAME

libssh2_session_get_timeout - get the timeout for blocking functions

SYNOPSIS

#include <libssh2.h>

long libssh2_session_get_timeout(LIBSSH2_SESSION *session);

DESCRIPTION

Returns the timeout (in milliseconds) for how long a blocking the libssh2 function calls may wait until they consider the situation an error and return LIBSSH2_ERROR_TIMEOUT.

By default libssh2 has no timeout (zero) for blocking functions.

RETURN VALUE

The value of the timeout setting.

AVAILABILITY

Added in 1.2.9