third_party/ot-br-posix/repo/src/agent/agent_instance.hpp

   1 /*
   2  *    Copyright (c) 2017, The OpenThread Authors.
   3  *    All rights reserved.
   4  *
   5  *    Redistribution and use in source and binary forms, with or without
   6  *    modification, are permitted provided that the following conditions are met:
   7  *    1. Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *    2. Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *    3. Neither the name of the copyright holder nor the
  13  *       names of its contributors may be used to endorse or promote products
  14  *       derived from this software without specific prior written permission.
  15  *
  16  *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  *    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  *    POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /**
  30  * @file
  31  *   This file includes definition for Thread border router agent instance.
  32  */
  33
  34 #ifndef OTBR_AGENT_AGENT_INSTANCE_HPP_
  35 #define OTBR_AGENT_AGENT_INSTANCE_HPP_
  36
  37 #include "openthread-br/config.h"
  38
  39 #include <stdarg.h>
  40 #include <stdint.h>
  41 #include <sys/select.h>
  42 #include <sys/types.h>
  43
  44 #include "agent/border_agent.hpp"
  45 #include "agent/instance_params.hpp"
  46 #include "agent/ncp.hpp"
  47
  48 namespace otbr {
  49
  50 /**
  51  * This class implements an instance to host services used by border router.
  52  *
  53  */
  54 class AgentInstance
  55 {
  56 public:
  57     /**
  58      * The constructor to initialize the Thread border router agent instance.
  59      *
  60      * @param[in]   aNcp  A pointer to the NCP controller.
  61      *
  62      */
  63     AgentInstance(Ncp::Controller *aNcp);
  64
  65     ~AgentInstance(void);
  66
  67     /**
  68      * This method initialize the agent.
  69      *
  70      * @retval  OTBR_ERROR_NONE     Agent initialized successfully.
  71      * @retval  OTBR_ERROR_ERRNO    Failed due to error indicated in errno.
  72      *
  73      */
  74     otbrError Init(void);
  75
  76     /**
  77      * This method updates the file descriptor sets and timeout for mainloop.
  78      *
  79      * @param[inout]    aMainloop   A reference to OpenThread mainloop context.
  80      *
  81      */
  82     void UpdateFdSet(otSysMainloopContext &aMainloop);
  83
  84     /**
  85      * This method performs processing.
  86      *
  87      * @param[in]       aMainloop   A reference to OpenThread mainloop context.
  88      *
  89      */
  90     void Process(const otSysMainloopContext &aMainloop);
  91
  92     /**
  93      * This method return mNcp pointer.
  94      *
  95      * @retval  the pointer of mNcp.
  96      *
  97      */
  98     Ncp::Controller &GetNcp(void) { return *mNcp; }
  99
 100 private:
 101     Ncp::Controller *mNcp;
 102     BorderAgent      mBorderAgent;
 103 };
 104
 105 } // namespace otbr
 106
 107 #endif // OTBR_AGENT_AGENT_INSTANCE_HPP_