aboutsummaryrefslogtreecommitdiffstats
path: root/hicn-light/src/strategies/strategyImpl.h
diff options
context:
space:
mode:
Diffstat (limited to 'hicn-light/src/strategies/strategyImpl.h')
-rwxr-xr-xhicn-light/src/strategies/strategyImpl.h66
1 files changed, 66 insertions, 0 deletions
diff --git a/hicn-light/src/strategies/strategyImpl.h b/hicn-light/src/strategies/strategyImpl.h
new file mode 100755
index 000000000..c089e0b2b
--- /dev/null
+++ b/hicn-light/src/strategies/strategyImpl.h
@@ -0,0 +1,66 @@
+/*
+ * 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.
+ */
+
+/**
+ * @file strategyImpl.h
+ * @brief Defines the function structure for a Strategy implementation
+ *
+ * <#Detailed Description#>
+ *
+ */
+
+/**
+ * A dispatch structure for a concrete implementation of a forwarding strategy.
+ */
+
+#ifndef strategyImpl_h
+#define strategyImpl_h
+
+#include <src/core/message.h>
+#include <src/core/numberSet.h>
+
+struct strategy_impl;
+typedef struct strategy_impl StrategyImpl;
+
+/**
+ * @typedef StrategyImpl
+ * @abstract Forwarding strategy implementation
+ * @constant receiveObject is called when we receive an object and have a
+ * measured round trip time. This allows a strategy to update its performance
+ * data.
+ * @constant lookupNexthop Find the set of nexthops to use for the Interest.
+ * May be empty, should not be NULL. Must be destroyed.
+ * @constant addNexthop Add a nexthop to the list of available nexthops with a
+ * routing protocol-specific cost.
+ * @constant destroy cleans up the strategy, freeing all memory and state. A
+ * strategy is reference counted, so the final destruction only happens after
+ * the last reference is released.
+ * @discussion <#Discussion#>
+ */
+struct strategy_impl {
+ void *context;
+ void (*receiveObject)(StrategyImpl *strategy, const NumberSet *egressId,
+ const Message *objectMessage, Ticks rtt);
+ void (*onTimeout)(StrategyImpl *strategy, const NumberSet *egressId);
+ NumberSet *(*lookupNexthop)(StrategyImpl *strategy,
+ const Message *interestMessage);
+ NumberSet *(*returnNexthops)(StrategyImpl *strategy);
+ unsigned (*countNexthops)(StrategyImpl *strategy);
+ void (*addNexthop)(StrategyImpl *strategy, unsigned connectionId);
+ void (*removeNexthop)(StrategyImpl *strategy, unsigned connectionId);
+ void (*destroy)(StrategyImpl **strategyPtr);
+ strategy_type (*getStrategy)(StrategyImpl *strategy);
+};
+#endif // strategyImpl_h