Interface service definitions.
Defines the RPC for getting interface status(es).
RPC Calls | |
| rpc | SLInterfaceOper::SLInterfaceNotifStream (stream SLInterfaceNotifMsg) returns(stream SLInterfaceNotif) |
| This service can be used to receive interface state change notifications. More... | |
Messages | |
| message | SLInterfaceInfoMsgBw |
| message | SLInterfaceInfoMsg |
| Interface Get Message result. More... | |
| message | SLInterfaceNotifMsgEntry |
| Interface Notification Entry. More... | |
| message | SLInterfaceNotifMsg |
| Interface Notification message. More... | |
| message | SLInterfaceNotifMsgRes |
| Interface Notification message result. More... | |
| message | SLInterfaceNotifMsgErr |
| Interface Notification message error. More... | |
| message | SLInterfaceNotif |
| Interface Notification Event. More... | |
Enumerations | |
| enum | SLInterfaceState { SL_IF_STATE_UNKNOWN = 0, SL_IF_STATE_CREATED = 1, SL_IF_STATE_DOWN = 2, SL_IF_STATE_UP = 3, SL_IF_STATE_DELETED = 4, SL_IF_STATE_BW_CHANGED = 5, SL_IF_STATE_L2_UP = 6, SL_IF_STATE_L2_DOWN = 7 } |
| The current state of the interface. More... | |
| rpc SLInterfaceOper::SLInterfaceNotifStream | ( | stream | SLInterfaceNotifMsg | ) |
This service can be used to receive interface state change notifications.
This call is used to get a stream of interface notifications. The caller must maintain the GRPC channel as long as there is interest in interface notifications. This call can be used to get "push" notifications for interface info. It is advised that the caller register for notifications before any interfaces are used to avoid any loss of notifications.
| message SLInterfaceInfoMsgBw |
Attributes | |
| uint64 | NewBandwidth = 1 |
| The New Bandwidth. | |
| uint64 | OldBandwidth = 2 |
| The Old Bandwidth prior to the update. | |
| message SLInterfaceInfoMsg |
Interface Get Message result.
Attributes | |
| SLInterface | SLIfInfo = 1 |
| Interface info. | |
| SLInterfaceState | IfState = 2 |
| Interface state. | |
| int64 | Timestamp = 3 |
| Timestamp in microseconds since Epoch January 1st, 1970 00:00:00 GMT, a.k.a. More... | |
| oneof { | |
| SLInterfaceInfoMsgBw BwInfo = 10 | |
| case IfState SL_IF_STATE_BW_CHANGED is set: | |
| }; | |
| int64 SLInterfaceInfoMsg::Timestamp = 3 |
Timestamp in microseconds since Epoch January 1st, 1970 00:00:00 GMT, a.k.a.
unix epoch.
| message SLInterfaceNotifMsgEntry |
Interface Notification Entry.
Attributes | |
| uint64 | OperationId = 1 |
| OperationId. More... | |
| bool | Regex = 2 |
| If true, the Name in the Interface field is a regex. More... | |
| SLInterface | Interface = 3 |
| Interface key attributes. More... | |
| repeated SLInterfaceState | States = 4 |
| Interface states that this notification entry is interested in. | |
| SLInterface SLInterfaceNotifMsgEntry::Interface = 3 |
Interface key attributes.
Only SLInterface.Name is supported. The Name can be a regular expression.
| uint64 SLInterfaceNotifMsgEntry::OperationId = 1 |
OperationId.
This can be used to correlate replies with requests. The Server simply reflects this field back in the reply. See SLInterfaceNotifMsgRes.
| bool SLInterfaceNotifMsgEntry::Regex = 2 |
If true, the Name in the Interface field is a regex.
Else, the Name field is an exact match.
| message SLInterfaceNotifMsg |
Interface Notification message.
Attributes | |
| SLNotifOp | Oper = 1 |
| Notification Operation. | |
| repeated SLInterfaceNotifMsgEntry | Entries = 2 |
| Notification Entries. | |
| message SLInterfaceNotifMsgRes |
Interface Notification message result.
Attributes | |
| uint64 | OperationId = 1 |
| OperationId. More... | |
| SLErrorStatus | ErrStatus = 2 |
| Corresponding error code. | |
| SLInterface | Key = 3 |
| Interface key attributes. | |
| uint64 SLInterfaceNotifMsgRes::OperationId = 1 |
OperationId.
This can be used to correlate replies with requests. The Server simply reflects this field back in the reply. See SLInterfaceNotifMsgEntry.
| message SLInterfaceNotifMsgErr |
Interface Notification message error.
Attributes | |
| repeated SLInterfaceNotifMsgRes | Details = 1 |
| Interface key attributes. | |
| message SLInterfaceNotif |
Interface Notification Event.
Attributes | |
| oneof { | |
| SLInterfaceNotifMsgErr Error = 1 | |
| This field carries error info, if any error occurs during notification subscription. More... | |
| SLInterfaceInfoMsg Info = 2 | |
| This field carries the notification info. | |
| }; | |
| SLInterfaceNotifMsgErr SLInterfaceNotif::Error = 1 |
This field carries error info, if any error occurs during notification subscription.
| enum SLInterfaceState |
The current state of the interface.
