GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LIBSSH2_SESSION_DISCONNECT_EX (3)

NAME

libssh2_session_disconnect_ex - terminate transport layer

CONTENTS

Synopsis
Description
Return Value
See Also

SYNOPSIS

#include <libssh2.h>

int libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang);

int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description);

DESCRIPTION

session - Session instance as returned by libssh2_session_init_ex(3)

reason - One of the Disconnect Reason constants.

description - Human readable reason for disconnection.

lang - Localization string describing the language/encoding of the description provided.

Send a disconnect message to the remote host associated with session, along with a reason symbol and a verbose description.

As a convenience, the macro libssh2_session_disconnect(3) is provided. It calls libssh2_session_disconnect_ex(3) with reason set to SSH_DISCONNECT_BY_APPLICATION and lang set to an empty string.

RETURN VALUE

Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn’t really a failure per se.

SEE ALSO

libssh2_session_init_ex(3)
Search for    or go to Top of page |  Section 3 |  Main Index


libssh2 0.15 LIBSSH2_SESSION_DISCONNECT_EX (3) 1 Jun 2007

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.