interface.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 FACEMGR_INTERFACE_H
#define FACEMGR_INTERFACE_H
 
#include <stdbool.h>
#include <hicn/facemgr/loop.h>
 
typedef enum {
    INTERFACE_CB_TYPE_REGISTER_FD,
    INTERFACE_CB_TYPE_UNREGISTER_FD,
    INTERFACE_CB_TYPE_RAISE_EVENT,
    INTERFACE_CB_TYPE_REGISTER_TIMER,
    INTERFACE_CB_TYPE_UNREGISTER_TIMER,
} interface_cb_type_t;
 
typedef int (*interface_cb_t)(facemgr_t * facemgr, interface_cb_type_t type, void * data);
 
struct interface_s;
typedef struct {
    char * type;
    /* Constructor */
    int (*initialize)(struct interface_s * interface, void * cfg);
    /* Destructor */
    int (*finalize)(struct interface_s * interface);
    /* Callback upon file descriptor event (iif previously registered) */
    int (*callback)(struct interface_s * interface, int fd, void * data);
    /* Callback upon face events coming from the face manager */
    int (*on_event)(struct interface_s * interface, struct facelet_s * facelet);
} interface_ops_t;
 
typedef struct interface_s {
    char * name;
    const interface_ops_t * ops;
 
    interface_cb_t callback;
    void * callback_owner;
 
    void * data;
} interface_t;
 
int interface_register(const interface_ops_t * ops);
 
int interface_unregister_all();
 
int interface_unregister_all();
 
interface_t * interface_create(const char * name, const char * type);
 
void interface_free(interface_t * interface);
 
 
void interface_set_callback(interface_t * interface, void * callback_owner, interface_cb_t callback);
 
int interface_initialize(interface_t * interface, void * cfg);
 
int interface_finalize(interface_t * interface);
 
int interface_on_event(interface_t * interface, struct facelet_s * facelet);
 
int interface_callback(interface_t * interface, interface_cb_type_t type, void * data);
 
int interface_raise_event(interface_t * interface, facelet_t * facelet);
 
int interface_register_fd(interface_t * interface, int fd, void * data);
 
int interface_unregister_fd(interface_t * interface, int fd);
 
typedef int (*interface_fd_callback_t)(interface_t * interface, int fd, void * unused);
 
int interface_register_timer(interface_t * interface, unsigned delay_ms,
        interface_fd_callback_t callback, void * data);
 
int interface_unregister_timer(interface_t * interface, int fd);
 
#endif /* FACEMGR_INTERFACE_H */