CNetwork Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CNetwork class handles network session management, messaging and information for multiplayer games

The structure used for this class is CNetwork

Quick Reference¶

Quick Ref

void CNetwork::CNetwork()

void CNetwork::~CNetwork()

void CNetwork::AddMessageToWindow(int idDPTo, unsigned long dwFlags, void* lpData, unsigned long dwDataSize)

unsigned char CNetwork::AddPlayerToList(int dpID, CString& sPlayerName, unsigned char bIsHost, unsigned char bMakeVisible)

bool CNetwork::CheckForServiceProviderConnection()

unsigned char CNetwork::CheckSessionStatus(unsigned char bInThreadLoop)

void CNetwork::CloseSession(unsigned char bAIResponsible)

unsigned char CNetwork::CreatePlayer(int& nErrorCode)

void CNetwork::EnumeratePlayers(unsigned char bProtectList)

unsigned char CNetwork::EnumerateServiceProviders()

unsigned char* CNetwork::FetchFrame(int& dpIDFrom, unsigned long& dwSize)

unsigned char* CNetwork::FetchMessage(int& nMsgFrom, int& nMsgTo, unsigned long& dwSize)

unsigned char* CNetwork::FetchSpecificMessage(CString& sPlayerName, unsigned char nSpecMsgType, unsigned char nSpecMsgSubType, unsigned long& dwSize)

int CNetwork::FindPlayerIDByName(CString& sPlayerName, unsigned char bInvisible)

int CNetwork::FindPlayerLocationByID(int dpID, unsigned char bInvisible)

int CNetwork::FindPlayerLocationByName(CString& sPlayerName, unsigned char bInvisible)

int CNetwork::FindPlayerNumberByName(CString& sPlayerName)

int CNetwork::GetHostPlayerID()

void CNetwork::GetHostPlayerName(CString& sHostName)

unsigned char CNetwork::GetPasswordRequiredForSelectedSession()

int CNetwork::GetPlayerID(const int nPlayerNumber)

void CNetwork::GetPlayerName(const int nPlayerNumber, CString& sPlayerName)

int CNetwork::GetRawPlayerID(const int nPlayerNumber)

void CNetwork::GetRawPlayerName(const int nPlayerNumber, CString& sPlayerName)

unsigned char CNetwork::GetServiceProviderType(int nServiceProviderNumber, int& nServiceProviderType)

unsigned char CNetwork::HostNewSession()

unsigned char CNetwork::InitializeConnectionToServiceProvider(unsigned char bHostingGame)

unsigned char CNetwork::JoinSelectedSession(int& nErrorCode)

unsigned char CNetwork::KickPlayer(int dpID, unsigned char bAIResponsible)

unsigned char CNetwork::MakePlayersVisible()

void CNetwork::OnCloseSession()

void CNetwork::OnOpenSession()

unsigned char CNetwork::PeekMessageA()

unsigned char CNetwork::PeekSpecificMessage(CString& sPlayerName, unsigned char nSpecMsgType, unsigned char nSpecMsgSubType)

void CNetwork::RemoveAllPlayersFromList()

void CNetwork::RemoveInitializeConnection()

unsigned char CNetwork::RemovePlayerFromList(int dpID, unsigned char bAIResponsible)

void CNetwork::RequestSessionDetails(int sessionNumber)

unsigned char CNetwork::SelectServiceProvider(int nServiceProviderNumber)

unsigned char CNetwork::SelectSession(int nSessionNumber)

unsigned char CNetwork::SendMessageA(CString& sPlayerName, unsigned long dwFlags, void* lpData, unsigned long nDataSize)

unsigned char CNetwork::SendSpecificMessage(CString& sPlayerName, unsigned long dwFlags, unsigned char nSpecMsgType, unsigned char nSpecMsgSubType, void* lpData, unsigned long nDataSize)

void CNetwork::SetApplicationOptions(unsigned char bKeepAlive, unsigned char bMigrateHost)

unsigned char CNetwork::SetInSessionOptions()

void CNetwork::SetJoinEnabled(unsigned char bJoinEnabled)

void CNetwork::SetMaxPlayers(int nMaxPlayers)

void CNetwork::SlidingWindowReceive()

void CNetwork::SlidingWindowSend()

int CNetwork::ThreadLoop()

void CNetwork::UnselectServiceProvider()

void CNetwork::UnselectSession()

Constructors¶

Name	Description
CNetwork::CNetwork	Constructs a `CNetwork` object
CNetwork::~CNetwork	Destroys a `CNetwork` object

CNetwork::CNetwork¶

Constructs a CNetwork object

void CNetwork::CNetwork();

Remarks

Constructs a CNetwork object

CNetwork::~CNetwork¶

Destroys the CNetwork object

void CNetwork::~CNetwork();

Remarks

Destroys the CNetwork object

Methods¶

Name	Description
CNetwork::AddMessageToWindow
CNetwork::AddPlayerToList
CNetwork::CheckForServiceProviderConnection
CNetwork::CheckSessionStatus
CNetwork::CloseSession
CNetwork::CreatePlayer
CNetwork::EnumeratePlayers
CNetwork::EnumerateServiceProviders
CNetwork::FetchFrame
CNetwork::FetchMessage
CNetwork::FetchSpecificMessage
CNetwork::FindPlayerIDByName
CNetwork::FindPlayerLocationByID
CNetwork::FindPlayerLocationByName
CNetwork::FindPlayerNumberByName
CNetwork::GetHostPlayerID
CNetwork::GetHostPlayerName
CNetwork::GetPasswordRequiredForSelectedSession
CNetwork::GetPlayerID
CNetwork::GetPlayerName
CNetwork::GetRawPlayerID
CNetwork::GetRawPlayerName
CNetwork::GetServiceProviderType
CNetwork::HostNewSession
CNetwork::InitializeConnectionToServiceProvider
CNetwork::JoinSelectedSession
CNetwork::KickPlayer
CNetwork::MakePlayersVisible
CNetwork::OnCloseSession
CNetwork::OnOpenSession
CNetwork::PeekMessageA
CNetwork::PeekSpecificMessage
CNetwork::RemoveAllPlayersFromList
CNetwork::RemoveInitializeConnection
CNetwork::RemovePlayerFromList
CNetwork::RequestSessionDetails
CNetwork::SelectServiceProvider
CNetwork::SelectSession
CNetwork::SendMessageA
CNetwork::SendSpecificMessage
CNetwork::SetApplicationOptions
CNetwork::SetInSessionOptions
CNetwork::SetJoinEnabled
CNetwork::SetMaxPlayers
CNetwork::SlidingWindowReceive
CNetwork::SlidingWindowSend
CNetwork::ThreadLoop
CNetwork::UnselectServiceProvider
CNetwork::UnselectSession

CNetwork::AddMessageToWindow¶

void CNetwork::AddMessageToWindow(
   int idDPTo,
   unsigned long dwFlags,
   void* lpData,
   unsigned long dwDataSize);

Parameters

int idDPTo -
unsigned long dwFlags -
void* lpData -
unsigned long dwDataSize -

Remarks

CNetwork::AddPlayerToList¶

unsigned char CNetwork::AddPlayerToList(
   int dpID,
   CString& sPlayerName,
   unsigned char bIsHost,
   unsigned char bMakeVisible);

Parameters

int dpID -
CString& sPlayerName -
unsigned char bIsHost -
unsigned char bMakeVisible -

Return Value

Returns unsigned char

Remarks

CNetwork::CheckForServiceProviderConnection¶

bool CNetwork::CheckForServiceProviderConnection();

Return Value

Returns bool

Remarks

CNetwork::CheckSessionStatus¶

unsigned char CNetwork::CheckSessionStatus(unsigned char bInThreadLoop);

Parameters

unsigned char bInThreadLoop -

Return Value

Returns unsigned char

Remarks

CNetwork::CloseSession¶

void CNetwork::CloseSession(unsigned char bAIResponsible);

Parameters

unsigned char bAIResponsible -

Remarks

CNetwork::CreatePlayer¶

unsigned char CNetwork::CreatePlayer(int& nErrorCode);

Parameters

int& nErrorCode -

Return Value

Returns unsigned char

Remarks

CNetwork::EnumeratePlayers¶

void CNetwork::EnumeratePlayers(unsigned char bProtectList);

Parameters

unsigned char bProtectList -

Remarks

CNetwork::EnumerateServiceProviders¶

unsigned char CNetwork::EnumerateServiceProviders();

Return Value

Returns unsigned char

Remarks

CNetwork::FetchFrame¶

unsigned char* CNetwork::FetchFrame(
   int& dpIDFrom,
   unsigned long& dwSize);

Parameters

int& dpIDFrom -
unsigned long& dwSize -

Return Value

Returns unsigned char*

Remarks

CNetwork::FetchMessage¶

unsigned char* CNetwork::FetchMessage(
   int& nMsgFrom,
   int& nMsgTo,
   unsigned long& dwSize);

Parameters

int& nMsgFrom -
int& nMsgTo -
unsigned long& dwSize -

Return Value

Returns unsigned char*

Remarks

CNetwork::FetchSpecificMessage¶

unsigned char* CNetwork::FetchSpecificMessage(
   CString& sPlayerName,
   unsigned char nSpecMsgType,
   unsigned char nSpecMsgSubType,
   unsigned long& dwSize);

Parameters

CString& sPlayerName -
unsigned char nSpecMsgType -
unsigned char nSpecMsgSubType -
unsigned long& dwSize -

Return Value

Returns unsigned char*

Remarks

CNetwork::FindPlayerIDByName¶

int CNetwork::FindPlayerIDByName(
   CString& sPlayerName,
   unsigned char bInvisible);

Parameters

CString& sPlayerName -
unsigned char bInvisible -

Return Value

Returns int

Remarks

CNetwork::FindPlayerLocationByID¶

int CNetwork::FindPlayerLocationByID(
   int dpID,
   unsigned char bInvisible);

Parameters

int dpID -
unsigned char bInvisible -

Return Value

Returns int

Remarks

CNetwork::FindPlayerLocationByName¶

int CNetwork::FindPlayerLocationByName(
   CString& sPlayerName,
   unsigned char bInvisible);

Parameters

CString& sPlayerName -
unsigned char bInvisible -

Return Value

Returns int

Remarks

CNetwork::FindPlayerNumberByName¶

int CNetwork::FindPlayerNumberByName(CString& sPlayerName);

Parameters

CString& sPlayerName -

Return Value

Returns int

Remarks

CNetwork::GetHostPlayerID¶

int CNetwork::GetHostPlayerID();

Return Value

Returns int

Remarks

CNetwork::GetHostPlayerName¶

void CNetwork::GetHostPlayerName(CString& sHostName);

Parameters

CString& sHostName -

Remarks

CNetwork::GetPasswordRequiredForSelectedSession¶

unsigned char CNetwork::GetPasswordRequiredForSelectedSession();

Return Value

Returns unsigned char

Remarks

CNetwork::GetPlayerID¶

int CNetwork::GetPlayerID(const int nPlayerNumber);

Parameters

const int nPlayerNumber -

Return Value

Returns int

Remarks

CNetwork::GetPlayerName¶

void CNetwork::GetPlayerName(
   const int nPlayerNumber,
   CString& sPlayerName);

Parameters

const int nPlayerNumber -
CString& sPlayerName -

Remarks

CNetwork::GetRawPlayerID¶

int CNetwork::GetRawPlayerID(const int nPlayerNumber);

Parameters

const int nPlayerNumber -

Return Value

Returns int

Remarks

CNetwork::GetRawPlayerName¶

void CNetwork::GetRawPlayerName(
   const int nPlayerNumber,
   CString& sPlayerName);

Parameters

const int nPlayerNumber -
CString& sPlayerName -

Remarks

CNetwork::GetServiceProviderType¶

unsigned char CNetwork::GetServiceProviderType(
   int nServiceProviderNumber,
   int& nServiceProviderType);

Parameters

int nServiceProviderNumber -
int& nServiceProviderType -

Return Value

Returns unsigned char

Remarks

CNetwork::HostNewSession¶

unsigned char CNetwork::HostNewSession();

Return Value

Returns unsigned char

Remarks

CNetwork::InitializeConnectionToServiceProvider¶

unsigned char CNetwork::InitializeConnectionToServiceProvider(unsigned char bHostingGame);

Parameters

unsigned char bHostingGame -

Return Value

Returns unsigned char

Remarks

CNetwork::JoinSelectedSession¶

unsigned char CNetwork::JoinSelectedSession(int& nErrorCode);

Parameters

int& nErrorCode -

Return Value

Returns unsigned char

Remarks

CNetwork::KickPlayer¶

unsigned char CNetwork::KickPlayer(
   int dpID,
   unsigned char bAIResponsible);

Parameters

int dpID -
unsigned char bAIResponsible -

Return Value

Returns unsigned char

Remarks

CNetwork::MakePlayersVisible¶

unsigned char CNetwork::MakePlayersVisible();

Return Value

Returns unsigned char

Remarks

CNetwork::OnCloseSession¶

void CNetwork::OnCloseSession();

Remarks

CNetwork::OnOpenSession¶

void CNetwork::OnOpenSession();

Remarks

CNetwork::PeekMessageA¶

unsigned char CNetwork::PeekMessageA();

Return Value

Returns unsigned char

Remarks

CNetwork::PeekSpecificMessage¶

unsigned char CNetwork::PeekSpecificMessage(
   CString& sPlayerName,
   unsigned char nSpecMsgType,
   unsigned char nSpecMsgSubType);

Parameters

CString& sPlayerName -
unsigned char nSpecMsgType -
unsigned char nSpecMsgSubType -

Return Value

Returns unsigned char

Remarks

CNetwork::RemoveAllPlayersFromList¶

void CNetwork::RemoveAllPlayersFromList();

Remarks

CNetwork::RemoveInitializeConnection¶

void CNetwork::RemoveInitializeConnection();

Remarks

CNetwork::RemovePlayerFromList¶

unsigned char CNetwork::RemovePlayerFromList(
   int dpID,
   unsigned char bAIResponsible);

Parameters

int dpID -
unsigned char bAIResponsible -

Return Value

Returns unsigned char

Remarks

CNetwork::RequestSessionDetails¶

void CNetwork::RequestSessionDetails(int sessionNumber);

Parameters

int sessionNumber -

Remarks

CNetwork::SelectServiceProvider¶

unsigned char CNetwork::SelectServiceProvider(int nServiceProviderNumber);

Parameters

int nServiceProviderNumber -

Return Value

Returns unsigned char

Remarks

CNetwork::SelectSession¶

unsigned char CNetwork::SelectSession(int nSessionNumber);

Parameters

int nSessionNumber -

Return Value

Returns unsigned char

Remarks

CNetwork::SendMessageA¶

unsigned char CNetwork::SendMessageA(
   CString& sPlayerName,
   unsigned long dwFlags,
   void* lpData,
   unsigned long nDataSize);

Parameters

CString& sPlayerName -
unsigned long dwFlags -
void* lpData -
unsigned long nDataSize -

Return Value

Returns unsigned char

Remarks

CNetwork::SendSpecificMessage¶

unsigned char CNetwork::SendSpecificMessage(
   CString& sPlayerName,
   unsigned long dwFlags,
   unsigned char nSpecMsgType,
   unsigned char nSpecMsgSubType,
   void* lpData,
   unsigned long nDataSize);

Parameters

CString& sPlayerName -
unsigned long dwFlags -
unsigned char nSpecMsgType -
unsigned char nSpecMsgSubType -
void* lpData -
unsigned long nDataSize -

Return Value

Returns unsigned char

Remarks

CNetwork::SetApplicationOptions¶

void CNetwork::SetApplicationOptions(
   unsigned char bKeepAlive,
   unsigned char bMigrateHost);

Parameters

unsigned char bKeepAlive -
unsigned char bMigrateHost -

Remarks

CNetwork::SetInSessionOptions¶

unsigned char CNetwork::SetInSessionOptions();

Return Value

Returns unsigned char

Remarks

CNetwork::SetJoinEnabled¶

void CNetwork::SetJoinEnabled(unsigned char bJoinEnabled);

Parameters

unsigned char bJoinEnabled -

Return Value

Remarks

CNetwork::SetMaxPlayers¶

void CNetwork::SetMaxPlayers(int nMaxPlayers);

Parameters

int nMaxPlayers -

Remarks

CNetwork::SlidingWindowReceive¶

void CNetwork::SlidingWindowReceive();

Remarks

CNetwork::SlidingWindowSend¶

void CNetwork::SlidingWindowSend();

Remarks

CNetwork::ThreadLoop¶

int CNetwork::ThreadLoop();

Return Value

Returns int

Remarks

CNetwork::UnselectServiceProvider¶

void CNetwork::UnselectServiceProvider();

Remarks

CNetwork::UnselectSession¶

void CNetwork::UnselectSession();

Remarks