aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/java/jvpp-registry/io/fd/vpp/jvpp/VppConnection.java
blob: e6fd3bdb257035b1c634cec849b2bf090d4d34c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.fd.vpp.jvpp;

import java.io.IOException;

/**
 * Representation of a management connection to VPP.
 */
public interface VppConnection extends AutoCloseable {

    /**
     * Opens VppConnection for communication with VPP.
     *
     * @throws IOException if connection is not established
     */
    void connect() throws IOException;

    /**
     * Checks if this instance connection is active.
     *
     * @throws IllegalStateException if this instance was disconnected.
     */
    void checkActive();

    /**
     * Closes Vpp connection.
     */
    @Override
    void close();
}