libssh 0.11.1 The SSH library

Loading...
Searching...
No Matches
channels.h
1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2009 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef CHANNELS_H_
22#define CHANNELS_H_
23#include "libssh/priv.h"
24
25#ifdef __cplusplus
26 extern "C" {
27#endif
28
33 enum ssh_channel_request_state_e {
35 SSH_CHANNEL_REQ_STATE_NONE = 0,
37 SSH_CHANNEL_REQ_STATE_PENDING,
39 SSH_CHANNEL_REQ_STATE_ACCEPTED,
41 SSH_CHANNEL_REQ_STATE_DENIED,
43 SSH_CHANNEL_REQ_STATE_ERROR
44};
45
46 enum ssh_channel_state_e {
47 SSH_CHANNEL_STATE_NOT_OPEN = 0,
48 SSH_CHANNEL_STATE_OPENING,
49 SSH_CHANNEL_STATE_OPEN_DENIED,
50 SSH_CHANNEL_STATE_OPEN,
51 SSH_CHANNEL_STATE_CLOSED
52};
53
54/* The channel has been closed by the remote side */
55#define SSH_CHANNEL_FLAG_CLOSED_REMOTE 0x0001
56
57/* The channel has been closed locally */
58#define SSH_CHANNEL_FLAG_CLOSED_LOCAL 0x0002
59
60/* The channel has been freed by the calling program */
61#define SSH_CHANNEL_FLAG_FREED_LOCAL 0x0004
62
63/* the channel has not yet been bound to a remote one */
64#define SSH_CHANNEL_FLAG_NOT_BOUND 0x0008
65
66 struct ssh_channel_struct {
67 ssh_session session; /* SSH_SESSION pointer */
68 uint32_t local_channel;
69 uint32_t local_window;
70 int local_eof;
71 uint32_t local_maxpacket;
72
73 uint32_t remote_channel;
74 uint32_t remote_window;
75 int remote_eof; /* end of file received */
76 uint32_t remote_maxpacket;
77 enum ssh_channel_state_e state;
78 int delayed_close;
79 int flags;
80 ssh_buffer stdout_buffer;
81 ssh_buffer stderr_buffer;
82 void *userarg;
83 struct {
84 bool status;
85 uint32_t code;
86 char *signal;
87 bool core_dumped;
88 } exit;
89 enum ssh_channel_request_state_e request_state;
90 struct ssh_list *callbacks; /* list of ssh_channel_callbacks */
91
92 /* counters */
93 ssh_counter counter;
94};
95
96 SSH_PACKET_CALLBACK(ssh_packet_channel_open_conf);
97 SSH_PACKET_CALLBACK(ssh_packet_channel_open_fail);
98 SSH_PACKET_CALLBACK(ssh_packet_channel_success);
99 SSH_PACKET_CALLBACK(ssh_packet_channel_failure);
100 SSH_PACKET_CALLBACK(ssh_request_success);
101 SSH_PACKET_CALLBACK(ssh_request_denied);
102
103 SSH_PACKET_CALLBACK(channel_rcv_change_window);
104 SSH_PACKET_CALLBACK(channel_rcv_eof);
105 SSH_PACKET_CALLBACK(channel_rcv_close);
106 SSH_PACKET_CALLBACK(channel_rcv_request);
107 SSH_PACKET_CALLBACK(channel_rcv_data);
108
109 int channel_default_bufferize(ssh_channel channel,
110 void *data, uint32_t len,
111 bool is_stderr);
112 int ssh_channel_flush(ssh_channel channel);
113uint32_t ssh_channel_new_id(ssh_session session);
114ssh_channel ssh_channel_from_local(ssh_session session, uint32_t id);
115 void ssh_channel_do_free(ssh_channel channel);
116 int ssh_global_request(ssh_session session,
117 const char *request,
118 ssh_buffer buffer,
119 int reply);
120
121#ifdef __cplusplus
122}
123#endif
124
125#endif /* CHANNELS_H_ */
SSH_PACKET_CALLBACK
#define SSH_PACKET_CALLBACK(name)
This macro declares a packet callback handler.
Definition callbacks.h:560