summaryrefslogtreecommitdiffstats
path: root/Src/IP/MostMsgTx.h
blob: 00736aedda0dd490506f171f812cc45bca183790 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 * Video On Demand Samples
 *
 * Copyright (C) 2015 Microchip Technology Germany II GmbH & Co. KG
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * You may also obtain this software under a propriety license from Microchip.
 * Please contact Microchip for further information.
 *
 */

/*----------------------------------------------------------*/
/*! \file
 *  \brief  This file contains the CMostMsgTx class.
 */
/*----------------------------------------------------------*/
#ifndef MOSTMSGTX_H
#define MOSTMSGTX_H

#include <stdint.h>
#include <stdbool.h>
#include "MostMsg.h"
#include "MsgAddr.h"




/*----------------------------------------------------------*/
/*!
* \brief  class holding a MOST message which needs to be
*         sent
*/

/*----------------------------------------------------------*/
class CMostMsgTx : public CMostMsg
{
private:
    typedef void ( *OnMessageSent_t )( bool bSucceeded, CMostMsgTx *Msg );
    CMsgAddr *m_Addr;
    uint32_t m_nTimeoutMs;
    OnMessageSent_t m_MessageSent;
    void *m_UserContext;

protected:
    virtual ~CMostMsgTx();

public:


    /*----------------------------------------------------------*/
    /*! \brief constructs a new message
    *
    * \param Addr - Target address
    * \param nFBlock - Function Block ID
    * \param nInst - Instance ID
    * \param nFunc - Function ID
    * \param nOpType - Operation
    * \param nPayloadLen - length of payload in bytes
    * \param Payload - Payload
    * \param nTimeoutMs - Timeout for sending in Milliseconds
    * \param MessageSentCB - Handler called, after message was sent
    * \param UserContext - a class passed to the handler
    */
    /*----------------------------------------------------------*/
    CMostMsgTx( CMsgAddr *Addr, uint32_t nFBlock, uint32_t nInst, uint32_t nFunc, uint8_t nOpType,
        uint32_t nPayloadLen, const uint8_t *Payload, uint32_t nTimeoutMs, OnMessageSent_t MessageSentCB,
        void *UserContext );


    void MsgSent( bool bSuccess );




    CMsgAddr *GetAddr();




    void *GetUserContext();
};


#endif //MOSTMSGTX_H