source: arduino-1-6-7/trunk/fuentes/arduino-ide-amd64/libraries/Bridge/src/Mailbox.h @ 46

Last change on this file since 46 was 46, checked in by jrpelegrina, 4 years ago

First release to Xenial

File size: 1.7 KB
Line 
1/*
2  Copyright (c) 2013 Arduino LLC. All right reserved.
3
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Lesser General Public
6  License as published by the Free Software Foundation; either
7  version 2.1 of the License, or (at your option) any later version.
8
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Lesser General Public License for more details.
13
14  You should have received a copy of the GNU Lesser General Public
15  License along with this library; if not, write to the Free Software
16  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17*/
18
19#ifndef _MAILBOX_CLASS_H_INCLUDED_
20#define _MAILBOX_CLASS_H_INCLUDED_
21
22#include <Bridge.h>
23
24class MailboxClass {
25  public:
26    MailboxClass(BridgeClass &b = Bridge) : bridge(b) { }
27
28    void begin() { }
29    void end() { }
30
31    // Receive a message and store it inside a buffer
32    unsigned int readMessage(uint8_t *buffer, unsigned int size);
33    // Receive a message and store it inside a String
34    void readMessage(String &str, unsigned int maxLength = 128);
35
36    // Send a message
37    void writeMessage(const uint8_t *buffer, unsigned int size);
38    // Send a message
39    void writeMessage(const String& str);
40    // Send a JSON message
41    void writeJSON(const String& str);
42
43    // Return the size of the next available message, 0 if there are
44    // no messages in queue.
45    unsigned int messageAvailable();
46
47  private:
48    BridgeClass &bridge;
49};
50
51extern MailboxClass Mailbox;
52
53#endif // _MAILBOX_CLASS_H_INCLUDED_
Note: See TracBrowser for help on using the repository browser.