Aw session

From ActiveWiki
Revision as of 15:54, 28 October 2008 by Macavity (talk | contribs) (Added in, cleanup)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Minimum requirements
Added in version 2.1
SDKbuild 13


int aw_session (void)

Description

Returns the session number of the current instance.

Callback

None (returns immediately)

Notes

Session numbers are assigned by the universe server to uniquely identify an Active Worlds login session. Certain events such as network communication failures can cause new session numbers to be assigned on the fly to an existing instance.

Several API events use session numbers to uniquely identify other Active Worlds users.

Arguments

None

Argument attributes

None

Return values

Session number of the current instance.

Returned attributes

None

Usage

Print a message whenever the session number changes.

int session = aw_session ();

for (;;)
{
  if (session != aw_session ())
  {
    session = aw_session ();
    printf ("New session number: %d\n", session);
  }
  aw_wait (1000);
}

See also