src/app/util/chip-message-send.h

   1 /*
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, softwarEchoe
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 /**
  19  * @file
  20  *   This file declares a function that can be called to send a unicast message
  21  *   (in the form of a buffer and length) to a given response destination node
  22  *   id.
  23  */
  24
  25 #pragma once
  26
  27 #include "types_stub.h" // For EmberApsFrame, EmberStatus, node ids.
  28
  29 /**
  30  * @brief
  31  *    Called to send a unicast message.  The message is constructed
  32  *    by serializing the given APS frame followed by the actual message
  33  *    buffer passed in.
  34  *
  35  * @param[in] destination The destination node id to send the message to.
  36  * @param[in] apsFrame The APS frame to use for the message.
  37  * @param[in] messageLength The length of the message to send after the APS
  38  *                          frame.
  39  * @param[in] message The message to send after the APS frame.
  40  */
  41 EmberStatus chipSendUnicast(chip::NodeId destination, EmberApsFrame * apsFrame, uint16_t messageLength, uint8_t * message);