aboutsummaryrefslogtreecommitdiffstats
path: root/metis/ccnx/forwarder/metis/core/metis_ConnectionManager.h
blob: d4cd1f3a7235062642519bcd3661bcc1987f3fd9 (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) 2017 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.
 */

/**
 * @file metis_ConnectionManager.h
 * @brief The connection manager handles connection events, such as going down
 *
 * The connection manager listens to the event notification system.  Based on those
 * events, the connection manager will take specific actions.  This is expected
 * to be a singleton instantiated by metis_Forwarder.
 *
 *   METIS_CONN_UP:
 *      - send a notification to appropriate local applications that want to
 *        known when connections come up.
 *
 *   METIS_CONN_DOWN:
 *      - Tear down the connection
 *      - Send a notification to local applications
 *
 */

#ifndef Metis_metis_ConnectionManager_h
#define Metis_metis_ConnectionManager_h

#include <ccnx/forwarder/metis/core/metis_Forwarder.h>

struct metis_connection_manager;
typedef struct metis_connection_manager MetisConnectionManager;

MetisConnectionManager *metisConnectionManager_Create(MetisForwarder *metis);

void metisConnectionManager_Destroy(MetisConnectionManager **managerPtr);
#endif // Metis_metis_ConnectionManager_h