FreeNOS
NetworkSocket.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Niek Linnenbank
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program 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
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __LIBNET_NETWORKSOCKET_H
19 #define __LIBNET_NETWORKSOCKET_H
20 
21 #include <File.h>
22 #include <Types.h>
23 #include "NetworkQueue.h"
24 #include "NetworkClient.h"
25 
37 class NetworkSocket : public File
38 {
39  public:
40 
48  NetworkSocket(const u32 inode,
49  const Size packetSize,
50  const ProcessID pid);
51 
55  virtual ~NetworkSocket();
56 
62  ProcessID getProcessID() const;
63 
71  virtual FileSystem::Result process(const NetworkQueue::Packet *pkt) = 0;
72 
73  protected:
74 
77 
80 
83 
86 };
87 
93 #endif /* __LIBNET_NETWORKSOCKET_H */
NetworkSocket::process
virtual FileSystem::Result process(const NetworkQueue::Packet *pkt)=0
Process incoming network packet.
Types.h
ProcessID
u32 ProcessID
Process Identification Number.
Definition: Types.h:140
NetworkQueue.h
NetworkQueue
Networking packet queue implementation.
Definition: NetworkQueue.h:37
File
Represents a file present on a FileSystem.
Definition: File.h:39
NetworkSocket::m_receive
NetworkQueue m_receive
Receive queue.
Definition: NetworkSocket.h:79
NetworkSocket::getProcessID
ProcessID getProcessID() const
Get owner ProcessID.
Definition: NetworkSocket.cpp:36
NetworkSocket::NetworkSocket
NetworkSocket(const u32 inode, const Size packetSize, const ProcessID pid)
Constructor.
Definition: NetworkSocket.cpp:21
NetworkSocket::m_info
NetworkClient::SocketInfo m_info
Socket connection.
Definition: NetworkSocket.h:85
NetworkSocket::~NetworkSocket
virtual ~NetworkSocket()
Destructor.
Definition: NetworkSocket.cpp:32
u32
unsigned int u32
Unsigned 32-bit number.
Definition: Types.h:53
Size
unsigned int Size
Any sane size indicator cannot go negative.
Definition: Types.h:128
NetworkSocket::m_transmit
NetworkQueue m_transmit
Transmit queue.
Definition: NetworkSocket.h:82
NetworkSocket
Network socket represents a single logical connection on a protocol.
Definition: NetworkSocket.h:37
NetworkClient::SocketInfo
Socket information.
Definition: NetworkClient.h:65
FileSystem::Result
Result
Result code for filesystem Actions.
Definition: FileSystem.h:52
NetworkClient.h
NetworkQueue::Packet
Represents a network packet.
Definition: NetworkQueue.h:50
File.h
NetworkSocket::m_pid
const ProcessID m_pid
ProcessID which owns this socket.
Definition: NetworkSocket.h:76