lib/xdsserver/terminal-interface.go

   1 /*
   2  * Copyright (C) 2018 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package xdsserver
  19
  20 import (
  21         "gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
  22         socketio "github.com/googollee/go-socket.io"
  23 )
  24
  25 // ITERMINAL Terminal interface
  26 type ITERMINAL interface {
  27         GetConfig() xsapiv1.TerminalConfig                                          // Get terminal public configuration
  28         UpdateConfig(cfg xsapiv1.TerminalConfig) *xsapiv1.TerminalConfig            // Update terminal config
  29         Open(sock *socketio.Socket, sessID string) (*xsapiv1.TerminalConfig, error) // Open a terminal session
  30         Close() (*xsapiv1.TerminalConfig, error)                                    // Close a terminal session
  31         Resize(cols, rows uint16) (*xsapiv1.TerminalConfig, error)                  // Resize a terminal session
  32         Signal(sigName string) error                                                // Send a signal to a terminal session
  33 }