Raritan / Server Technology Xerus™ PDU JSON-RPC API: Sx.idl Source File

Raritan / Server Technology Xerus™ PDU JSON-RPC API

Sx.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2022 Raritan Inc. All rights reserved.
4 */
5
6 #ifndef __SX_IDL__
7 #define __SX_IDL__
8
9 #include <UserEvent.idl>
10
11 module sx {
12
13 /** Serial access port interface */
14 interface Sx {
15
16 /** Client info */
17 structure ClientInfo {
18 string portId; ///< Serial access port id
19 string portName; ///< Serial access port name
20 string userName; ///< User name
21 string userIp; ///< User IP address (or <local> if this is a local session)
22 };
23
24 /** Event that is send when a client has connected to the port */
25 valueobject ClientConnectionStatusEvent extends event.UserEvent {
26 ClientInfo clientInfo; ///< Client info
27 boolean status; ///< true: connected; false: disconnected
28 int clientCnt; ///< total client count
29 };
30
31 };
32
33 }
34
35 #endif // __SX_IDL__
sx::Sx
Serial access port interface.
Definition: Sx.idl:14
sx::Sx::ClientConnectionStatusEvent
Event that is send when a client has connected to the port.
Definition: Sx.idl:25
sx::Sx::ClientConnectionStatusEvent::status
boolean status
true: connected; false: disconnected
Definition: Sx.idl:27
sx::Sx::ClientConnectionStatusEvent::clientInfo
ClientInfo clientInfo
Client info.
Definition: Sx.idl:26
sx::Sx::ClientConnectionStatusEvent::clientCnt
int clientCnt
total client count
Definition: Sx.idl:28
sx::Sx::ClientInfo
Client info.
Definition: Sx.idl:17
sx::Sx::ClientInfo::portName
string portName
Serial access port name.
Definition: Sx.idl:19
sx::Sx::ClientInfo::portId
string portId
Serial access port id.
Definition: Sx.idl:18
sx::Sx::ClientInfo::userName
string userName
User name.
Definition: Sx.idl:20
sx::Sx::ClientInfo::userIp
string userIp
User IP address (or <local> if this is a local session)
Definition: Sx.idl:21