File: Serial.h

package info (click to toggle)
railcontrol 24%2Bdfsg1-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,680 kB
  • sloc: cpp: 40,834; javascript: 2,509; makefile: 144; php: 97; sh: 60
file content (118 lines) | stat: -rw-r--r-- 3,084 bytes parent folder | download | duplicates (2)
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*
RailControl - Model Railway Control Software

Copyright (c) 2017-2025 by Teddy / Dominik Mahrer - www.railcontrol.org

RailControl 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, or (at your option) any
later version.

RailControl 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 RailControl; see the file LICENCE. If not see
<http://www.gnu.org/licenses/>.
*/

#pragma once

#include <mutex>
#include <string>
#include <termios.h>
#include <unistd.h>   //close & write;

#include "Logger/Logger.h"

namespace Network
{
	class Serial
	{
		public:
			Serial() = delete;
			Serial(const Serial&) = delete;
			Serial& operator=(const Serial&) = delete;

			inline Serial(Logger::Logger* logger,
				const std::string& tty,
				const unsigned int dataSpeed, // from termio (ex. B9600)
				const unsigned char dataBits,
				const char parity,
				const unsigned char stopBits,
				const bool hardwareFlowControl = false)
			:	logger(logger),
				tty(tty),
				dataSpeed(dataSpeed),
				dataBits(dataBits),
				parity(parity),
				stopBits(stopBits),
				hardwareFlowControl(hardwareFlowControl),
				fileHandle(-1)
			{
				Init();
			}

			~Serial()
			{
				Close();
			}

			inline void ReInit()
			{
				Close();
				Init();
			}

			inline bool IsConnected() const
			{
				return fileHandle != -1;
			}

			inline void ClearBuffers()
			{
				tcflush(fileHandle, TCIOFLUSH);
			}

			inline ssize_t Send(const std::string& data)
			{
				return Send(reinterpret_cast<const unsigned char*>(data.c_str()), data.length());
			}

			inline ssize_t Send(const unsigned char data)
			{
				return Send(&data, 1);
			}

			inline ssize_t Send(const unsigned char* data, const size_t size)
			{
				if (!IsConnected())
				{
					return 0;
				}
				std::lock_guard<std::mutex> Guard(fileHandleMutex);
				return write(fileHandle, data, size);
			}

			bool Receive(std::string& data, const size_t maxData = 1024, const unsigned int timeoutS = 0, const unsigned int timeoutUS = 100000);
			ssize_t Receive(unsigned char* data, const size_t maxData, const unsigned int timeoutS = 0, const unsigned int timeoutUS = 100000);
			bool ReceiveExact(std::string& data, const size_t length, const unsigned int timeoutS = 0, const unsigned int timeoutUS = 100000);
			ssize_t ReceiveExact(unsigned char* data, const size_t length, const unsigned int timeoutS = 0, const unsigned int timeoutUS = 100000);

		private:
			void Init();
			void Close();

			Logger::Logger* logger;
			const std::string tty;
			const unsigned int dataSpeed;
			const unsigned char dataBits;
			const char parity;
			const unsigned char stopBits;
			const bool hardwareFlowControl;
			int fileHandle;
			mutable std::mutex fileHandleMutex;
	};
}