snap.h

Go to the documentation of this file.

//  Copyright (C) 2015-2020 Virgil Security, Inc.
//
//  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 the copyright holder 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 AUTHOR ''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 AUTHOR 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.
//
//  Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 
#ifndef AP_SECURITY_SDK_SNAP_H
#define AP_SECURITY_SDK_SNAP_H
 
#include <stdint.h>
 
#include <virgil/iot/protocols/snap/snap-structs.h>
#include <virgil/iot/status_code/status_code.h>
 
#ifdef __cplusplus
namespace VirgilIoTKit {
extern "C" {
#endif
 
vs_status_e
vs_snap_init(vs_netif_t *default_netif,
             const vs_device_manufacture_id_t manufacturer_id,
             const vs_device_type_t device_type,
             const vs_device_serial_t device_serial,
             uint32_t device_roles);
 
vs_status_e
vs_snap_deinit();
 
const vs_device_manufacture_id_t *
vs_snap_device_manufacture(void);
 
const vs_device_type_t *
vs_snap_device_type(void);
 
const vs_device_serial_t *
vs_snap_device_serial(void);
 
uint32_t
vs_snap_device_roles(void);
 
const vs_netif_t *
vs_snap_default_netif(void);
 
vs_status_e
vs_snap_send(const vs_netif_t *netif, const uint8_t *data, uint16_t data_sz);
 
vs_status_e
vs_snap_register_service(const vs_snap_service_t *service);
 
vs_status_e
vs_snap_mac_addr(const vs_netif_t *netif, vs_mac_addr_t *mac_addr);
 
const vs_mac_addr_t *
vs_snap_broadcast_mac(void);
 
vs_status_e
vs_snap_send_request(const vs_netif_t *netif,
                     const vs_mac_addr_t *mac,
                     vs_snap_service_id_t service_id,
                     vs_snap_element_t element_id,
                     const uint8_t *data,
                     uint16_t data_sz);
 
vs_snap_stat_t
vs_snap_get_statistics(void);
 
#ifdef __cplusplus
} // extern "C"
} // namespace VirgilIoTKit
#endif
 
#endif // AP_SECURITY_SDK_SNAP_H