ioOperations.h

/*
 * 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 io_h
#define io_h
 
#include <hicn/core/connectionState.h>
#include <hicn/core/message.h>
#include <hicn/core/ticks.h>
#include <hicn/io/addressPair.h>
#include <hicn/utils/address.h>
 
// packet types for probing
#define PACKET_TYPE_PROBE_REQUEST 5
#define PACKET_TYPE_PROBE_REPLY 6
 
struct io_ops;
typedef struct io_ops IoOperations;
 
struct io_ops {
  void *closure;
  bool (*send)(IoOperations *ops, const Address *nexthop, Message *message);
  bool (*sendIOVBuffer)(IoOperations *ops, struct iovec *message, size_t
      size);
  const Address *(*getRemoteAddress)(const IoOperations *ops);
  const AddressPair *(*getAddressPair)(const IoOperations *ops);
  bool (*isUp)(const IoOperations *ops);
  bool (*isLocal)(const IoOperations *ops);
  unsigned (*getConnectionId)(const IoOperations *ops);
  void (*destroy)(IoOperations **opsPtr);
  const void *(*class)(const IoOperations *ops);
  list_connections_type (*getConnectionType)(const IoOperations *ops);
  void (*sendProbe)(IoOperations *ops, uint8_t *message);
  connection_state_t (*getState)(const IoOperations *ops);
  void (*setState)(IoOperations *ops, connection_state_t state);
  connection_state_t (*getAdminState)(const IoOperations *ops);
  void (*setAdminState)(IoOperations *ops, connection_state_t admin_state);
#ifdef WITH_POLICY
  uint32_t (*getPriority)(const IoOperations *ops);
  void (*setPriority)(IoOperations *ops, uint32_t priority);
#endif /* WITH_POLICY */
  const char * (*getInterfaceName)(const IoOperations *ops);
};
 
void *ioOperations_GetClosure(const IoOperations *ops);
 
void ioOperations_Release(IoOperations **opsPtr);
 
bool ioOperations_Send(IoOperations *ops, const Address *nexthop,
    Message *message);
 
bool ioOperations_SendIOVBuffer(IoOperations *ops, struct iovec *message,
    size_t size);
 
const Address *ioOperations_GetRemoteAddress(const IoOperations *ops);
 
const AddressPair *ioOperations_GetAddressPair(const IoOperations *ops);
 
bool ioOperations_IsUp(const IoOperations *ops);
 
bool ioOperations_IsLocal(const IoOperations *ops);
 
unsigned ioOperations_GetConnectionId(const IoOperations *ops);
 
const void *ioOperations_Class(const IoOperations *ops);
 
list_connections_type ioOperations_GetConnectionType(const IoOperations *ops);
 
void ioOperations_SendProbe(IoOperations *ops, uint8_t *message);
 
 
connection_state_t ioOperations_GetState(const IoOperations *ops);
 
void ioOperations_SetState(IoOperations *ops, connection_state_t state);
 
connection_state_t ioOperations_GetAdminState(const IoOperations *ops);
 
void ioOperations_SetAdminState(IoOperations *ops, connection_state_t admin_state);
 
#ifdef WITH_POLICY
 
uint32_t ioOperations_GetPriority(const IoOperations *ops);
 
void ioOperations_SetPriority(IoOperations *ops, uint32_t priority);
#endif /* WITH_POLICY */
 
const char * ioOperations_GetInterfaceName(const IoOperations *ops);
 
#endif  // io_h