org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811

Interface OcpProtocolService

All Superinterfaces:

RpcService

All Known Subinterfaces:

ConnectionAdapter

public interface OcpProtocolService
extends RpcService

Interface for implementing the following YANG RPCs defined in module ocp-protocol

 rpc get-state {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf objId {
             type ObjId;
         }
         leaf stateType {
             type StateAllType;
         }
         leaf eventDrivenReporting {
             type boolean;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type GetStateRes;
         }
         list obj {
             key "id"
             leaf id {
                 type ObjId;
             }
             list state {
                 key "type"
                 leaf type {
                     type StateType;
                 }
                 leaf value {
                     type StateVal;
                 }
             }
         }
     }
 }
 rpc re-reset {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type OriRes;
         }
     }
 }
 rpc set-time {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf newTime {
             type xsd-dateTime;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type OriRes;
         }
     }
 }
 rpc modify-param {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf objId {
             type ObjId;
         }
         list param {
             key "name"
             leaf name {
                 type string;
             }
             leaf value {
                 type string;
             }
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf globResult {
             type ModifyParamGlobRes;
         }
         leaf objId {
             type ObjId;
         }
         list param {
             key "name"
             leaf name {
                 type string;
             }
             leaf result {
                 type ModifyParamRes;
             }
         }
     }
 }
 rpc health-check {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf tcpLinkMonTimeout {
             type xsd-unsignedShort;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type OriRes;
         }
     }
 }
 rpc get-param {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf objId {
             type ObjId;
         }
         leaf paramName {
             type string;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type GetParamRes;
         }
         list obj {
             key "id"
             leaf id {
                 type ObjId;
             }
             list param {
                 key "name"
                 leaf name {
                     type string;
                 }
                 leaf value {
                     type string;
                 }
             }
         }
     }
 }
 rpc create-obj {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf objType {
             type ObjType;
         }
         list param {
             key "name"
             leaf name {
                 type string;
             }
             leaf value {
                 type string;
             }
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf globResult {
             type CreateObjGlobRes;
         }
         leaf objId {
             type ObjId;
         }
         list param {
             key "name"
             leaf name {
                 type string;
             }
             leaf result {
                 type CreateObjRes;
             }
         }
     }
 }
 rpc delete-obj {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf obj-id {
             type ObjId;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type DeleteObjRes;
         }
     }
 }
 rpc modify-state {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf objId {
             type ObjId;
         }
         leaf stateType {
             type StateType;
         }
         leaf stateValue {
             type StateVal;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type ModifyStateRes;
         }
         leaf objId {
             type ObjId;
         }
         leaf stateType {
             type StateType;
         }
         leaf stateValue {
             type StateVal;
         }
     }
 }
 rpc get-fault {
     input {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf objId {
             type ObjId;
         }
         leaf eventDrivenReporting {
             type boolean;
         }
     }
     
     output {
         leaf msgType {
             type OcpMsgType;
         }
         leaf xid {
             type uint32;
         }
         leaf result {
             type GetFaultRes;
         }
         list obj {
             key "id"
             leaf id {
                 type ObjId;
             }
             list fault {
                 key "id"
                 leaf id {
                     type FaultId;
                 }
                 leaf severity {
                     type FaultSeverity;
                 }
                 leaf timestamp {
                     type xsd-dateTime;
                 }
                 leaf descr {
                     type string;
                 }
                 leaf-list affectedObj {
                     type string;
                 }
             }
         }
     }
 }
 

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<CreateObjOutput>>	createObj(CreateObjInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<DeleteObjOutput>>	deleteObj(DeleteObjInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetFaultOutput>>	getFault(GetFaultInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetParamOutput>>	getParam(GetParamInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetStateOutput>>	getState(GetStateInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<HealthCheckOutput>>	healthCheck(HealthCheckInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<ModifyParamOutput>>	modifyParam(ModifyParamInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<ModifyStateOutput>>	modifyState(ModifyStateInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<ReResetOutput>>	reReset(ReResetInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetTimeOutput>>	setTime(SetTimeInput input)

Method Detail

getState

Future<org.opendaylight.yangtools.yang.common.RpcResult<GetStateOutput>> getState(GetStateInput input)

Returns:

java.util.concurrent.Future state, or null if not present

reReset

Future<org.opendaylight.yangtools.yang.common.RpcResult<ReResetOutput>> reReset(ReResetInput input)

setTime

Future<org.opendaylight.yangtools.yang.common.RpcResult<SetTimeOutput>> setTime(SetTimeInput input)

modifyParam

Future<org.opendaylight.yangtools.yang.common.RpcResult<ModifyParamOutput>> modifyParam(ModifyParamInput input)

healthCheck

Future<org.opendaylight.yangtools.yang.common.RpcResult<HealthCheckOutput>> healthCheck(HealthCheckInput input)

getParam

Future<org.opendaylight.yangtools.yang.common.RpcResult<GetParamOutput>> getParam(GetParamInput input)

Returns:

java.util.concurrent.Future param, or null if not present

createObj

Future<org.opendaylight.yangtools.yang.common.RpcResult<CreateObjOutput>> createObj(CreateObjInput input)

deleteObj

Future<org.opendaylight.yangtools.yang.common.RpcResult<DeleteObjOutput>> deleteObj(DeleteObjInput input)

modifyState

Future<org.opendaylight.yangtools.yang.common.RpcResult<ModifyStateOutput>> modifyState(ModifyStateInput input)

getFault

Future<org.opendaylight.yangtools.yang.common.RpcResult<GetFaultOutput>> getFault(GetFaultInput input)

Returns:

java.util.concurrent.Future fault, or null if not present