Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/network/network_socket.h @ 8881

Last change on this file since 8881 was 7954, checked in by patrick, 19 years ago

trunk: merged the network branche back to trunk.

File size: 1.5 KB
Line 
1/*!
2 * @file network_socket.h
3  *  Main interface for the network module. Manages all the modules
4
5*/
6
7#ifndef _NETWORK_SOCKET
8#define _NETWORK_SOCKET
9
10/* include this file, it contains some default definitions */
11#include "netdefs.h"
12
13
14/* include base_object.h since all classes are derived from this one */
15#include "base_object.h"
16
17class NetworkSocket : public BaseObject
18{
19  public:
20    NetworkSocket();
21    virtual ~NetworkSocket();
22
23    /**
24     * connect to server on host with port port
25     * @param host hostname might be xxx.xxx.xxx.xxx or localhost ...
26     * @param port port to connect to
27     */
28    virtual void connectToServer( std::string host, int port ) = 0;
29   
30    /**
31     * disconnect from server
32     */
33    virtual void disconnectServer() = 0;
34
35    /**
36     * send packet to connected socket. will be recieved as whole packet
37     * @param data pointer to data to send
38     * @param length lengt of packet to send
39     * @return true on success
40     */
41    virtual bool writePacket(byte * data, int length) = 0;
42   
43    /**
44     * read a packet sent by another NetworkSocket
45     * @param data data will be copied here
46     * @param maxLength readPacket will not read more than maxLength
47     * @return bytes read. on error less than zero
48     */
49    virtual int readPacket(byte * data, int maxLength) = 0;
50
51    /**
52     * check if socket is ok
53     * @return true if socket is ok
54     */
55    inline bool isOk() { return this->bOk; }
56 
57  protected:
58    bool bOk;            //!< check for socket status
59
60};
61
62
63
64#endif /* _NETWORK_SOCKET */
Note: See TracBrowser for help on using the repository browser.