/**************************************************************************************

       N M _ M D M P R X Y _ M A R K _ P R O V I D E R _ F A C T O R Y . H

***************************************************************************************/

/**************************************************************************************

  @file    nm_mdmproxy_mark_provider_factory.h
  @brief   Modem proxy plugin

  DESCRIPTION
  Header file for mark provider factory

**************************************************************************************/
/*====================================================================================

  Copyright (c) 2015 Qualcomm Technologies, Inc.
  All Rights Reserved.
  Confidential and Proprietary - Qualcomm Technologies, Inc.

======================================================================================*/

#ifndef __MDM_PROXY_MARK_FACTORY_H__
#define __MDM_PROXY_MARK_FACTORY_H__
#endif /* __MDM_PROXY_ROUTE_FACTORY_H__ */

/*=====================================================================================
                                  INCLUDE FILES
=====================================================================================*/

#include <inttypes.h>
#include <sys/socket.h>
#ifndef NETMGR_OFFTARGET
#include <netinet/in6.h>
#endif

/*=====================================================================================
                      LOCAL DEFINITIONS AND DECLARATIONS
=====================================================================================*/

typedef struct mark_provider_s
{
  /* Install and remove iptables marking rules */
  int (*install_rules) (sa_family_t);
  int (*remove_rules)  (sa_family_t);

  /* Specific use-cases */
  int (*install_spi_rule) (sa_family_t, unsigned int);
  int (*remove_spi_rule)  (sa_family_t, unsigned int);

  int     (*install_portfwd_rule) (sa_family_t, boolean);
  int     (*remove_portfwd_rule)  (sa_family_t, boolean);
  boolean (*query_portfwd_status) (sa_family_t);

  int (*install_icmp_rule)    (sa_family_t, char*);
  int (*remove_icmp_rule)     (sa_family_t, char*);

  int (*init)          (void);
  /* Global OOS and IS handlers */
  int (*is_hdlr)       (void);
  int (*oos_hdlr)      (void);

  void (*sigusr1_hdlr) (void);
} nm_mdmprxy_mark_prov_t;

/*=====================================================================================
                                PUBLIC FUNCTIONS
=====================================================================================*/

/*====================================================================================
  FUNCTION  nm_mdmprxy_get_mark_provider
====================================================================================*/
/*!
@brief
  Returns the mark provider instance based on modem query support

@return
  struct route_provider instance

@note

  - Dependencies
    - None

  - Side Effects
    - None
*/
/*==================================================================================*/
nm_mdmprxy_mark_prov_t *nm_mdmprxy_get_mark_provider(void);