vpp-api/java/jvpp/org/openvpp/jvpp/VppConnection.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.openvpp.jvpp;
  18
  19 /**
  20  * Representation of a management connection to VPP.
  21  * Connection is initiated when instance is created, closed with close().
  22  */
  23 public interface VppConnection extends AutoCloseable {
  24
  25     /**
  26      * Check if this instance connection is active.
  27      *
  28      * @throws IllegalStateException if this instance was disconnected.
  29      */
  30     void checkActive();
  31
  32     /**
  33      * Closes Vpp connection.
  34      */
  35     @Override
  36     void close();
  37 }