vp_connect_universe

Method call snippet vp_connect_universe(instance, "universe.virtualparadise.org", 57000);

Connects an instance to a universe server. Required before an instance log in with user credentials and entering a world.

Parameters

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for
string host	Host address of server to connect to; currently "universe.virtualparadise.org". IP addresses in dotted quad are also valid (e.g. the string "10.0.0.1").
int port	TCP port of remote server; currently 57000

Returns

This method returns a return code integer, which indicates whether the call was successful or errored for any reason:

Return code	Cause
VP_RC_SUCCESS	Successful call (for methods that have a registered callback, it only means the request has been sent)
VP_RC_CONNECTION_ERROR	Error connecting to the universe server
VP_RC_TIMEOUT	It took too long to connect or get a response from the server

Behavior

• If a VP_CALLBACK_CONNECT_UNIVERSE callback is set this function will return immediately and return the result using the callback, otherwise it will call vp_wait() in a loop until done.

Caveats

• To disconnect from a universe, vp_destroy() must be called.
• Passing a NULL pointer for the host parameter will cause a memory access violation. It will not cause a default host address to be used. Passing port number 0 will also not cause a default port to be used.
• VP_RC_CONNECTION_ERROR could be returned for many issues, such as invalid host, unable to resolve IP address, wrong or invalid port, etc.

Examples

int rc;

rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000);
if (rc)
    printf("Couldn't connect to universe (reason %d)", rc);

See also

• VP_CALLBACK_CONNECT_UNIVERSE
• vp_destroy()
• vp_login()