lib/xdsserver/terminal-interface.go


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

/*
 * Copyright (C) 2018 "IoT.bzh"
 * Author Sebastien Douheret <sebastien@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package xdsserver

import (
	"gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
	socketio "github.com/googollee/go-socket.io"
)

// ITERMINAL Terminal interface
type ITERMINAL interface {
	GetConfig() xsapiv1.TerminalConfig                                          // Get terminal public configuration
	UpdateConfig(cfg xsapiv1.TerminalConfig) *xsapiv1.TerminalConfig            // Update terminal config
	Open(sock *socketio.Socket, sessID string) (*xsapiv1.TerminalConfig, error) // Open a terminal session
	Close() (*xsapiv1.TerminalConfig, error)                                    // Close a terminal session
	Resize(cols, rows uint16) (*xsapiv1.TerminalConfig, error)                  // Resize a terminal session
	Signal(sigName string) error                                                // Send a signal to a terminal session
}