libssh 0.9.5 The SSH library

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
29 enum ssh_channel_request_state_e {
31 SSH_CHANNEL_REQ_STATE_NONE = 0,
33 SSH_CHANNEL_REQ_STATE_PENDING,
35 SSH_CHANNEL_REQ_STATE_ACCEPTED,
37 SSH_CHANNEL_REQ_STATE_DENIED,
39 SSH_CHANNEL_REQ_STATE_ERROR
40};
41
42 enum ssh_channel_state_e {
43 SSH_CHANNEL_STATE_NOT_OPEN = 0,
44 SSH_CHANNEL_STATE_OPENING,
45 SSH_CHANNEL_STATE_OPEN_DENIED,
46 SSH_CHANNEL_STATE_OPEN,
47 SSH_CHANNEL_STATE_CLOSED
48};
49
50/* The channel has been closed by the remote side */
51#define SSH_CHANNEL_FLAG_CLOSED_REMOTE 0x0001
52
53/* The channel has been closed locally */
54#define SSH_CHANNEL_FLAG_CLOSED_LOCAL 0x0002
55
56/* The channel has been freed by the calling program */
57#define SSH_CHANNEL_FLAG_FREED_LOCAL 0x0004
58
59/* the channel has not yet been bound to a remote one */
60#define SSH_CHANNEL_FLAG_NOT_BOUND 0x0008
61
62 struct ssh_channel_struct {
63 ssh_session session; /* SSH_SESSION pointer */
64 uint32_t local_channel;
65 uint32_t local_window;
66 int local_eof;
67 uint32_t local_maxpacket;
68
69 uint32_t remote_channel;
70 uint32_t remote_window;
71 int remote_eof; /* end of file received */
72 uint32_t remote_maxpacket;
73 enum ssh_channel_state_e state;
74 int delayed_close;
75 int flags;
76 ssh_buffer stdout_buffer;
77 ssh_buffer stderr_buffer;
78 void *userarg;
79 int exit_status;
80 enum ssh_channel_request_state_e request_state;
81 struct ssh_list *callbacks; /* list of ssh_channel_callbacks */
82
83 /* counters */
84 ssh_counter counter;
85};
86
87 SSH_PACKET_CALLBACK(ssh_packet_channel_open_conf);
88 SSH_PACKET_CALLBACK(ssh_packet_channel_open_fail);
89 SSH_PACKET_CALLBACK(ssh_packet_channel_success);
90 SSH_PACKET_CALLBACK(ssh_packet_channel_failure);
91 SSH_PACKET_CALLBACK(ssh_request_success);
92 SSH_PACKET_CALLBACK(ssh_request_denied);
93
94 SSH_PACKET_CALLBACK(channel_rcv_change_window);
95 SSH_PACKET_CALLBACK(channel_rcv_eof);
96 SSH_PACKET_CALLBACK(channel_rcv_close);
97 SSH_PACKET_CALLBACK(channel_rcv_request);
98 SSH_PACKET_CALLBACK(channel_rcv_data);
99
100 int channel_default_bufferize(ssh_channel channel,
101 void *data, size_t len,
102 bool is_stderr);
103 int ssh_channel_flush(ssh_channel channel);
104uint32_t ssh_channel_new_id(ssh_session session);
105 ssh_channel ssh_channel_from_local(ssh_session session, uint32_t id);
106 void ssh_channel_do_free(ssh_channel channel);
107 int ssh_global_request(ssh_session session,
108 const char *request,
109 ssh_buffer buffer,
110 int reply);
111
112#endif /* CHANNELS_H_ */
SSH_PACKET_CALLBACK
#define SSH_PACKET_CALLBACK(name)
This macro declares a packet callback handler.
Definition: callbacks.h:527
ssh_buffer_struct
Definition: buffer.c:47
ssh_channel_struct
Definition: channels.h:62
ssh_counter_struct
Definition: libssh.h:93
ssh_global_request
Definition: messages.h:50
ssh_list
Definition: misc.h:39
ssh_session_struct
Definition: session.h:109