fibEntry.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 fibEntry_h
#define fibEntry_h
 
#include <hicn/core/name.h>
#include <hicn/strategies/strategyImpl.h>
 
#ifdef WITH_POLICY
#include <hicn/core/connectionTable.h>
#endif /* WITH_POLICY */
 
#ifdef WITH_MAPME
#include <parc/algol/parc_EventTimer.h>
#include <parc/algol/parc_Iterator.h>
#endif /* WITH_MAPME */
 
struct fib_entry;
typedef struct fib_entry FibEntry;
 
#ifdef WITH_POLICY
struct forwarder;
FibEntry *fibEntry_Create(Name *name, strategy_type fwdStrategy, const struct forwarder * table);
#else
FibEntry *fibEntry_Create(Name *name, strategy_type fwdStrategy);
#endif
 
void fibEntry_Release(FibEntry **fibEntryPtr);
 
FibEntry *fibEntry_Acquire(const FibEntry *fibEntry);
 
void fibEntry_SetStrategy(FibEntry *fibEntry, strategy_type strategy,
                           unsigned related_prefixes_len,
                           Name **related_prefixes);
 
void fibEntry_AddNexthop(FibEntry *fibEntry, unsigned connectionId);
 
void fibEntry_RemoveNexthopByConnectionId(FibEntry *fibEntry,
                                          unsigned connectionId);
 
size_t fibEntry_NexthopCount(const FibEntry *fibEntry);
 
const NumberSet *fibEntry_GetNexthops(const FibEntry *fibEntry);
 
#ifdef WITH_POLICY
void fibEntry_ReceiveObjectMessage(FibEntry *fibEntry,
#else
void fibEntry_ReceiveObjectMessage(const FibEntry *fibEntry,
#endif /* WITH_POLICY */
                                   const NumberSet *egressId,
                                   const Message *objectMessage,
                                   Ticks pitEntryCreation,
                                   Ticks objReception);
 
#ifdef WITH_POLICY
hicn_policy_t fibEntry_GetPolicy(const FibEntry *fibEntry);
void fibEntry_ReconsiderPolicy(FibEntry *fibEntry);
void fibEntry_SetPolicy(FibEntry *fibEntry, hicn_policy_t policy);
void fibEntry_UpdateStats(FibEntry *fibEntry, uint64_t now);
NumberSet * fibEntry_GetAvailableNextHops(const FibEntry *fibEntry, unsigned in_connection);
NumberSet * fibEntry_GetPreviousNextHops(const FibEntry *fibEntry);
void fibEntry_SetPreviousNextHops(FibEntry *fibEntry, const NumberSet * nexthops);
 
void fibEntry_OnTimeout(FibEntry *fibEntry, const NumberSet *egressId);
const NumberSet *fibEntry_GetNexthopsFromForwardingStrategy(
    FibEntry *fibEntry, const Message *interestMessage, bool is_retransmission);
 
#else
void fibEntry_OnTimeout(const FibEntry *fibEntry, const NumberSet *egressId);
const NumberSet *fibEntry_GetNexthopsFromForwardingStrategy(
    const FibEntry *fibEntry, const Message *interestMessage);
#endif /* WITH_POLICY */
 
 
strategy_type fibEntry_GetFwdStrategyType(const FibEntry *fibEntry);
 
StrategyImpl *fibEntry_GetFwdStrategy(const FibEntry *fibEntry);
 
Name *fibEntry_GetPrefix(const FibEntry *fibEntry);
 
#ifdef WITH_MAPME
 
void *fibEntry_getUserData(const FibEntry *fibEntry);
 
void fibEntry_setUserData(FibEntry *fibEntry, const void *userDataOwner,
        const void *userData, void (*userDataRelease)(const void *, void **));
 
#endif /* WITH_MAPME */
 
#endif  // fibEntry_h