---

network.h

Go to the documentation of this file.

/*
        $Id: network.h,v 1.4 2001/03/23 15:09:36 mbn Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------

        File purpose:
                Network component header file.


*/


#ifndef header_network
#define header_network

#include <string>
class CL_NetSession;

class CL_Network
//: Network component class. Starting place for all net activity in ClanLib.
{
public:
        static void find_sessions_broadcast(
                std::string game_id,
                int port);
        //: Searchs for games using UDP broadcasting at the specified 'port'. 
        //: Only games with the same 'game_id' are added to CL_Network::netsessions.
        
        static void find_session_at(
                std::string app_id,
                const char *host_address,
                int port);
        //: Searchs for games at the specified host address and port ('port').
        
        static bool peek_session_found();
        //: Returns true if any netsessions have been found. Use receive_game_found() to
        //: get the individual games found.

        static CL_NetSession *receive_session_found(int timeout_millis);
        //: Returns the first netsession found. It is then removed from the list of games
        //: found. Next time it is called it will return the next in available. <br>
        //: The function is blocking until the specified timeout runs out.
        //: If set to zero, it will block forever until a game has been found.<br>
        //: Remember to delete the netsession returned after usage.

        static void clear_sessions_found();
        //: Clears the list of sessions found.

        static CL_NetSession *create_session(
                std::string app_id,
                int port);
        //: Creates a new network game.
};

#endif

---