connection.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019 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.
 */
 
#ifndef connection_h
#define connection_h
#include <hicn/hicn-light/config.h>
#include <hicn/core/connectionState.h>
#include <hicn/io/ioOperations.h>
#include <hicn/utils/address.h>
 
#ifdef WITH_MAPME
typedef enum {
  CONNECTION_EVENT_CREATE,
  CONNECTION_EVENT_DELETE,
  CONNECTION_EVENT_UPDATE,
  CONNECTION_EVENT_SET_UP,
  CONNECTION_EVENT_SET_DOWN,
  CONNECTION_EVENT_PRIORITY_CHANGED,
  CONNECTION_EVENT_TAGS_CHANGED,
} connection_event_t;
 
#endif /* WITH_MAPME */
 
#ifdef WITH_POLICY
#include <hicn/policy.h>
#endif /* WITH_POLICY */
 
struct connection;
typedef struct connection Connection;
 
Connection *connection_Create(IoOperations *ops);
 
void connection_Release(Connection **connectionPtr);
 
Connection *connection_Acquire(Connection *connection);
 
bool connection_Send(const Connection *conn, Message *message);
 
bool connection_SendIOVBuffer(const Connection *conn, struct iovec *msg,
    size_t size);
 
bool connection_SendBuffer(const Connection *conn, u8 * buffer, size_t length);
 
IoOperations *connection_GetIoOperations(const Connection *conn);
 
unsigned connection_GetConnectionId(const Connection *conn);
 
const AddressPair *connection_GetAddressPair(const Connection *conn);
 
bool connection_IsUp(const Connection *conn);
 
bool connection_IsLocal(const Connection *conn);
 
const void *connection_Class(const Connection *conn);
 
bool connection_ReSend(const Connection *conn, Message *message,
                       bool notification);
 
void connection_Probe(Connection *conn, uint8_t *probe);
 
void connection_HandleProbe(Connection *conn, uint8_t *message);
 
void connection_AllowWldrAutoStart(Connection *conn, bool allow);
 
void connection_EnableWldr(Connection *conn);
 
void connection_DisableWldr(Connection *conn);
 
bool connection_HasWldr(const Connection *conn);
 
bool connection_WldrAutoStartAllowed(const Connection *conn);
 
void connection_DetectLosses(Connection *conn, Message *message);
 
void connection_HandleWldrNotification(Connection *conn, Message *message);
 
connection_state_t connection_GetState(const Connection *conn);
 
void connection_SetState(Connection *conn, connection_state_t state);
 
connection_state_t connection_GetAdminState(const Connection *conn);
 
void connection_SetAdminState(Connection *conn, connection_state_t admin_state);
 
#ifdef WITH_POLICY
uint32_t connection_GetPriority(const Connection *conn);
 
void connection_SetPriority(Connection *conn, uint32_t priority);
#endif /* WITH_POLICY */
 
const char * connection_GetInterfaceName(const Connection * conn);
 
#ifdef WITH_POLICY
void connection_AddTag(Connection *conn, policy_tag_t tag);
void connection_RemoveTag(Connection *conn, policy_tag_t tag);
policy_tags_t connection_GetTags(const Connection *conn);
void connection_SetTags(Connection *conn, policy_tags_t tags);
void connection_ClearTags(Connection *conn);
int connection_HasTag(const Connection *conn, policy_tag_t tag);
#endif /* WITH_POLICY */
 
#endif  // connection_h