summaryrefslogtreecommitdiffstats
path: root/lib/vty_io_term.h
blob: 78d37b187f5fb2be0367b90e5852c50eab520b1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/* VTY IO TERM -- Telnet Terminal I/O -- header
 * Virtual terminal [aka TeletYpe] interface routine.
 * Copyright (C) 1997, 98 Kunihiro Ishiguro
 *
 * Revisions: Copyright (C) 2010 Chris Hall (GMCH), Highwayman
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef _ZEBRA_VTY_IO_TERM_H
#define _ZEBRA_VTY_IO_TERM_H

#include "misc.h"
#include <errno.h>

#include "vty.h"
#include "vty_io_basic.h"
#include "vty_io.h"
#include "vty_cli.h"

#include "vio_fifo.h"
#include "vio_lines.h"
#include "keystroke.h"
#include "thread.h"
#include "command_local.h"
#include "qstring.h"
#include "qtimers.h"

/*==============================================================================
 * Here are structures and other definitions which are shared by:
 *
 *   vty_io.c   -- the main VTY I/O stuff
 *
 * for I/O to Telnet Terminal.
 */

/*==============================================================================
 * Functions
 */

extern void uty_term_new(vty_io vio, int sock_fd) ;

extern cmd_return_code_t uty_term_fetch_command_line(vio_vf vf,
                                       cmd_action action, cmd_context context) ;
extern cmd_return_code_t uty_term_out_push(vio_vf vf, bool final) ;
extern uint uty_term_show_error_context(vio_vf vf, vio_fifo ebuf, uint depth) ;
extern cmd_return_code_t uty_term_read_close(vio_vf vf, bool final) ;
extern void uty_term_close_reason(vio_vf vf, const char* reason) ;
extern cmd_return_code_t uty_term_write_close(vio_vf vf, bool final);

extern int uty_term_read(vio_vf vf) ;
extern void uty_term_set_readiness(vio_vf vf, vty_readiness_t ready) ;

extern qtimer_action vty_term_pause_timeout ;

extern void uty_term_mon_write(vio_vf vf) ;

extern bool uty_telnet_command(vio_vf, keystroke stroke, bool callback) ;


extern void uty_term_open_listeners(const char *addr, unsigned short port) ;


#endif /* _ZEBRA_VTY_IO_TERM_H */