/* * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The OpenAirInterface Software Alliance licenses this file to You under * the OAI Public License, Version 1.1 (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.openairinterface.org/?page_id=698 * * 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. *------------------------------------------------------------------------------- * For more information about the OpenAirInterface (OAI) Software Alliance: * contact@openairinterface.org */ /*! \file flexran_agent_net_comm.h * \brief FlexRAN agent network interface abstraction * \autho Xenofon Foukas * \date 2016 * \version 0.1 */ #ifndef FLEXRAN_AGENT_NET_COMM_H_ #define FLEXRAN_AGENT_NET_COMM_H_ #include "flexran_agent_defs.h" #include "tree.h" /*Channel related information used for Tx/Rx of protocol messages*/ typedef struct flexran_agent_channel_s { RB_ENTRY(flexran_agent_channel_s) entry; int channel_id; void *channel_info; /*Callbacks for channel message Tx and Rx*/ int (*msg_send)(void *data, int size, int priority, void *channel_info); int (*msg_recv)(void **data, int *priority, void *channel_info); void (*release)(struct flexran_agent_channel_s *channel); } flexran_agent_channel_t; typedef struct flexran_agent_channel_instance_s{ RB_HEAD(flexran_agent_channel_map, flexran_agent_channel_s) flexran_agent_head; } flexran_agent_channel_instance_t; /*Send and receive messages using the channel registered for a specific agent*/ int flexran_agent_msg_send(mid_t mod_id, agent_id_t agent_id, void *data, int size, int priority); int flexran_agent_msg_recv(mid_t mod_id, agent_id_t agent_id, void **data, int *priority); /*Register a channel to an agent. Use FLEXRAN_AGENT_MAX to register the *same channel to all agents*/ int flexran_agent_register_channel(mid_t mod_id, flexran_agent_channel_t *channel, agent_id_t agent_id); /*Unregister the current channel of an agent. Use FLEXRAN_AGENT_MAX to unregister all channels*/ void flexran_agent_unregister_channel(mid_t mod_id, agent_id_t agent_id); /*Create a new channel. Returns the id of the new channel or negative number otherwise*/ int flexran_agent_create_channel(void *channel_info, int (*msg_send)(void *data, int size, int priority, void *channel_info), int (*msg_recv)(void **data, int *priority, void *channel_info), void (*release)(flexran_agent_channel_t *channel)); /*Unregister a channel from all agents and destroy it. Returns 0 in case of success*/ int flexran_agent_destroy_channel(int channel_id); /*Return an agent communication channel based on its id*/ flexran_agent_channel_t * get_channel(int channel_id); /*Should be called before performing any channel operations*/ err_code_t flexran_agent_init_channel_container(void); int flexran_agent_compare_channel(struct flexran_agent_channel_s *a, struct flexran_agent_channel_s *b); /* RB_PROTOTYPE is for .h files */ RB_PROTOTYPE(flexran_agent_channel_map, flexran_agent_channel_s, entry, flexran_agent_compare_channel); #endif /*FLEXRAN_AGENT_COMM_H_*/