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
|
/*
* NetworkResponder.h
*
* Created on: 14 Apr 2017
* Author: David
*/
#ifndef SRC_NETWORKING_NETWORKRESPONDER_H_
#define SRC_NETWORKING_NETWORKRESPONDER_H_
#include <RepRapFirmware.h>
#include <Platform/RepRap.h>
#include "NetworkDefs.h"
#include <Storage/FileData.h>
#include "NetworkBuffer.h"
#include <Platform/OutputMemory.h>
// Forward declarations
class NetworkResponder;
class NetworkInterface;
class Socket;
// Network responder base class
class NetworkResponder
{
public:
NetworkResponder(const NetworkResponder&) = delete;
NetworkResponder *GetNext() const noexcept { return next; }
virtual bool Spin() noexcept = 0; // do some work, returning true if we did anything significant
virtual bool Accept(Socket *s, NetworkProtocol protocol) noexcept = 0; // ask the responder to accept this connection, returns true if it did
virtual void Terminate(NetworkProtocol protocol, NetworkInterface *interface) noexcept = 0; // terminate the responder if it is serving the specified protocol on the specified interface
virtual void Diagnostics(MessageType mtype) const noexcept = 0;
protected:
// State machine control. Not all derived classes use all states.
enum class ResponderState
{
free = 0, // ready to be allocated
reading, // ready to receive data
sending, // sending data
uploading, // uploading a file to SD card
// HTTP responder additional states
processingRequest,
gettingFileInfo, // getting file info
// FTP responder additional states
waitingForPasvPort,
pasvPortOpened,
sendingPasvData,
pasvTransferComplete,
// Telnet responder additional states
justConnected,
authenticating
};
NetworkResponder(NetworkResponder *n) noexcept;
void Commit(ResponderState nextState = ResponderState::free, bool report = true) noexcept;
virtual void SendData() noexcept;
virtual void ConnectionLost() noexcept;
IPAddress GetRemoteIP() const noexcept;
void ReportOutputBufferExhaustion(const char *sourceFile, int line) noexcept;
static Platform& GetPlatform() noexcept { return reprap.GetPlatform(); }
static Network& GetNetwork() noexcept { return reprap.GetNetwork(); }
// General state
NetworkResponder *next; // next responder in the list
ResponderState responderState; // the current state
ResponderState stateAfterSending; // if we are sending, the state to enter when sending is complete
Socket *skt;
uint32_t timer; // a general purpose millisecond timer
// Buffers for sending responses
OutputBuffer *outBuf;
OutputStack outStack; // not volatile because only one task accesses it
#if HAS_MASS_STORAGE
FileStore *fileBeingSent;
#endif
NetworkBuffer *fileBuffer;
};
#endif /* SRC_NETWORKING_NETWORKRESPONDER_H_ */
|
