rpl_objective.h

00001 /*
00002  * Copyright (c) 2015, 2017-2018, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef RPL_OBJECTIVE_H_
00019 #define RPL_OBJECTIVE_H_
00020 
00021 #include "ns_list.h"
00022 
00023 struct rpl_instance;
00024 struct rpl_neighbour;
00025 
00026 typedef struct rpl_objective {
00027     /* The Objective Code Point in DODAG Configuration Option */
00028     uint16_t ocp;
00029     /* Run the parent selection algorithm - see rpl_of0.c for detailed info */
00030     void (*parent_selection)(struct rpl_instance *);
00031     /* Return the path cost of a neighbour (for debug prints only) */
00032     uint16_t (*path_cost)(const struct rpl_neighbour *);
00033     bool (*neighbour_acceptable)(const struct rpl_instance *, const struct rpl_neighbour *);
00034     ns_list_link_t link;
00035 } rpl_objective_t;
00036 
00037 /* Register a new objective function */
00038 void rpl_objective_register(rpl_objective_t *objective);
00039 
00040 /* Look up an objective function by OCP */
00041 rpl_objective_t *rpl_objective_lookup(uint16_t ocp);
00042 
00043 #endif /* RPL_OBJECTIVE_H_ */