vpp-api/java/jvpp-registry/io/fd/vpp/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 io.fd.vpp.jvpp;
  18
  19 import java.io.IOException;
  20
  21 /**
  22  * Representation of a management connection to VPP.
  23  */
  24 public interface VppConnection extends AutoCloseable {
  25
  26     /**
  27      * Opens VppConnection for communication with VPP.
  28      *
  29      * @throws IOException if connection is not established
  30      */
  31     void connect() throws IOException;
  32
  33     /**
  34      * Checks if this instance connection is active.
  35      *
  36      * @throws IllegalStateException if this instance was disconnected.
  37      */
  38     void checkActive();
  39
  40     /**
  41      * Closes Vpp connection.
  42      */
  43     @Override
  44     void close();
  45 }