/*
 * Copyright (c) 2023-2025 Ian Marco Moffett and the Osmora Team.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Hyra nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef LINK_H
#define LINK_H

#include <stdint.h>
#include "if_ether.h"

/*
 * Describes an ONET link
 *
 * @sockfd: Socket file descriptor
 * @iface_idx: Interface index in use
 * @hwaddr: Our hardware address
 * @last_recv: Hardware address of last received node
 */
struct onet_link {
    int sockfd;
    uint32_t iface_idx;
    mac_addr_t hwaddr;
    mac_addr_t last_recv;
};

/*
 * Open an ONET link
 *
 * @iface: The interface the link should be for
 * @res: Result is written here
 *
 * Returns zero on success, otherwise a less than
 * zero value on error.
 */
int onet_open(const char *iface, struct onet_link *res);

/*
 * Close an ONET link
 *
 * @olp: Link to close
 *
 * Returns zero on success, otherwise a less than
 * zero value on error.
 */
int onet_close(struct onet_link *olp);

#endif  /* LINK_H */