vp_wait

Method call snippet vp_wait(instance, 1000);

Pumps incoming and outgoing network traffic and fires any registered callbacks and events.

Parameters

These are the parameters that this method requires:

Parameter	Usage
VPInstance instance	Pointer to the instance this method call is intended for
int milliseconds	Maximum amount of time to pump (in milliseconds)

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_NOT_SUPPORTED	vp_wait is not supported by this instance, for example a custom vp_net_config was passed to vp_create()
VP_RC_RECURSIVE_WAIT	vp_wait was called recursively on the same instance (calling it from within an event/callback handler)
VP_RC_CONNECTION_ERROR	Waiting for data failed or there are no connections to wait for events on

Behavior

• This method will attempt to send all pending messages and receive all pending data within the given time limit
  • It will wait for the full number of milliseconds if no network messages are received (or are already waiting to be processed)
  • If one or more messages are received while waiting (or were received since the last call to vp_wait), then it will return after processing them and firing any registered event/callback handler functions.
  • If a value of 0 milliseconds is passed, it will process any messages that have been received since the last call to vp_wait (i.e. "polling")

• All SDK events and SDK callbacks are fired from this method call. Consequently, they are fired on the same thread as the caller

Caveats

This method should never be called inside an event handler originating from a previous vp_wait() call. Note: The current SDK will simply return VP_RC_RECURSIVE_WAIT. For example:

...
vp_event_set(instance, VP_EVENT_AVATAR_ADD, event_avatar_add);
while(vp_wait(instance, 1000) == 0){}
...
void event_avatar_add(VPInstance instance)
{
    char message[300];
    sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
    vp_say(instance, (char*)&message);
    vp_wait(instance, 1000); // Undefined behavior
}

The millisecond parameter should not be used for any sort of timekeeping,

while (vp_wait(instance, 5000)) {
  vp_say(instance, "5 seconds have passed!"); // this is not guaranteed to occur every 5 seconds (if any message is received while waiting)
}

Examples

This method has no usage examples; please add at least one to this page

See also

• vp_event_set()