Vp wait - Revision history

Sleepy E at 21:58, 20 August 2018

2018-08-20T21:58:09Z

← Older revision		Revision as of 21:58, 20 August 2018
Line 8:		Line 8:
	{{sdk return code row\|connection_error \|Waiting for data failed or there are no connections to wait for events on}}		{{sdk return code row\|connection_error \|Waiting for data failed or there are no connections to wait for events on}}
	\|behavior=		\|behavior=
	* This will attempt to send all pending messages and receive all pending data within the given time limit		* 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.
	* It will wait for the full number of milliseconds if no network messages are received ~~for the whole duration.~~		** If a value of {{code\|0}} milliseconds is passed, it will process any messages that have been received since the last call to vp_wait (i.e. "polling")
	* If one or more messages are received while waiting, then it will return after processing them (and firing any registered event/callback handler functions).


	* If a value of {{code\|0}} is passed, it ~~could still fire a number of different events~~

	* All [[:Category:SDK events\|SDK events]] and [[:Category:SDK callbacks\|SDK callbacks]] are fired from this method call. Consequently, they are fired on the same thread as the caller		* All [[:Category:SDK events\|SDK events]] and [[:Category:SDK callbacks\|SDK callbacks]] are fired from this method call. Consequently, they are fired on the same thread as the caller
	* If there is nothing to handle, it will wait until the time limit (or until one or more events or callbacks callback is fired). Else, it will return immediately after handling all pending data.
	\|caveats=		\|caveats=
	This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. The current SDK will return {{code\|VP_RC_RECURSIVE_WAIT}}. For example:		This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. Note: The current SDK will simply return {{code\|VP_RC_RECURSIVE_WAIT}}. For example:
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	...		...
Line 26:		Line 21:
	while(vp_wait(instance, 1000) == 0){}		while(vp_wait(instance, 1000) == 0){}
	...		...
	void event_avatar_add(VPInstance ~~sdk~~)		void event_avatar_add(VPInstance instance)
	{		{
	char message[300];		char message[300];
	sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));		sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
	vp_say(~~sdk~~, (char*)&message);		vp_say(instance, (char*)&message);
	vp_wait(instance, 1000); // Undefined behavior		vp_wait(instance, 1000); // Undefined behavior
			}
			</syntaxhighlight>

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

			<syntaxhighlight lang="c">
			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)
	}		}
	</syntaxhighlight>		</syntaxhighlight>

Sleepy E at 21:40, 20 August 2018

2018-08-20T21:40:05Z

← Older revision		Revision as of 21:40, 20 August 2018
Line 1:		Line 1:
	{{sdk method page\|wait\|Pumps incoming and outgoing network traffic and fires any registered ~~events. Required for most in-world method calls (e.g. {{sdk method\|say}})~~ and events ~~to actually happen~~.		{{sdk method page\|wait\|Pumps incoming and outgoing network traffic and fires any registered callbacks and events.
	\|paramex=1000		\|paramex=1000
	\|parameters=		\|parameters=
Line 5:		Line 5:
	\|returncodes=		\|returncodes=
	{{sdk return code row\|not_supported \|vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method\|create}}}}		{{sdk return code row\|not_supported \|vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method\|create}}}}
	{{sdk return code row\|recursive_wait \|vp_wait was called recursively on the same instance}}		{{sdk return code row\|recursive_wait \|vp_wait was called recursively on the same instance (calling it from within an event/callback handler)}}
	{{sdk return code row\|connection_error \|Waiting for data failed or there are no connections to wait for events on}}		{{sdk return code row\|connection_error \|Waiting for data failed or there are no connections to wait for events on}}
	\|behavior=		\|behavior=
	* This will attempt to send all pending messages and receive all pending data within the given time limit		* This will attempt to send all pending messages and receive all pending data within the given time limit
	* ~~All [[:Category:SDK events\|SDK events]] and [[:Category:SDK callbacks\|SDK callbacks]]~~ are ~~fired from this method call~~. ~~Consequently~~, ~~they are fired on the same thread as the caller~~.

			* It will wait for the full number of milliseconds if no network messages are received for the whole duration.
			* If one or more messages are received while waiting, then it will return after processing them (and firing any registered event/callback handler functions).


	* If a value of {{code\|0}} is passed, it could still fire a number of different events		* If a value of {{code\|0}} is passed, it could still fire a number of different events
	* If there is nothing to handle, it will wait until the time limit. Else, it will return immediately after handling all pending data
			* All [[:Category:SDK events\|SDK events]] and [[:Category:SDK callbacks\|SDK callbacks]] are fired from this method call. Consequently, they are fired on the same thread as the caller
			* If there is nothing to handle, it will wait until the time limit (or until one or more events or callbacks callback is fired). Else, it will return immediately after handling all pending data.
	\|caveats=		\|caveats=
	This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. ~~Doing so is undefined behavior and may break the internal~~ SDK ~~state~~. For example:		This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. The current SDK will return {{code\|VP_RC_RECURSIVE_WAIT}}. For example:
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	...		...

Sleepy E: Removed reason code

2016-12-17T17:15:08Z

Removed reason code

← Older revision		Revision as of 17:15, 17 December 2016
Line 4:		Line 4:
	{{sdk parameter row\|int\|milliseconds\|Maximum amount of time to pump (in milliseconds)}}		{{sdk parameter row\|int\|milliseconds\|Maximum amount of time to pump (in milliseconds)}}
	\|returncodes=		\|returncodes=
	{{sdk return code row\|~~NOT_INITIALIZED \|SDK not initialized with {{sdk method\|init}} yet}}~~		{{sdk return code row\|not_supported \|vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method\|create}}}}
	~~{{sdk return code row\|NOT_SUPPORTED~~ \|vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method\|create}}}}		{{sdk return code row\|recursive_wait \|vp_wait was called recursively on the same instance}}
	{{sdk return code row\|~~RECURSIVE_WAIT~~ \|vp_wait was called recursively on the same instance}}		{{sdk return code row\|connection_error \|Waiting for data failed or there are no connections to wait for events on}}
	{{sdk return code row\|~~CONNECTION_ERROR~~ \|Waiting for data failed or there are no connections to wait for events on}}
	\|behavior=		\|behavior=
	* This will attempt to send all pending messages and receive all pending data within the given time limit		* This will attempt to send all pending messages and receive all pending data within the given time limit

Sleepy E: Forgot to mention callbacks are fired too

2016-12-13T21:34:21Z

Forgot to mention callbacks are fired too

← Older revision		Revision as of 21:34, 13 December 2016
Line 10:		Line 10:
	\|behavior=		\|behavior=
	* This will attempt to send all pending messages and receive all pending data within the given time limit		* This will attempt to send all pending messages and receive all pending data within the given time limit
	* All [[:Category:SDK events\|SDK events]] are fired from this method call. Consequently, ~~events~~ are fired on the same thread as the caller.		* All [[:Category:SDK events\|SDK events]] and [[:Category:SDK callbacks\|SDK callbacks]] are fired from this method call. Consequently, they are fired on the same thread as the caller.
	* If a value of {{code\|0}} is passed, it could still fire a number of different events		* If a value of {{code\|0}} is passed, it could still fire a number of different events
	* If there is nothing to handle, it will wait until the time limit. Else, it will return immediately after handling all pending data		* If there is nothing to handle, it will wait until the time limit. Else, it will return immediately after handling all pending data

Sleepy E: Added reason codes

2016-12-13T21:17:37Z

Added reason codes

← Older revision		Revision as of 21:17, 13 December 2016
Line 4:		Line 4:
	{{sdk parameter row\|int\|milliseconds\|Maximum amount of time to pump (in milliseconds)}}		{{sdk parameter row\|int\|milliseconds\|Maximum amount of time to pump (in milliseconds)}}
	\|returncodes=		\|returncodes=
	{{sdk return code row\|NOT_INITIALIZED\|SDK not initialized with {{sdk method\|init}} yet}}		{{sdk return code row\|NOT_INITIALIZED \|SDK not initialized with {{sdk method\|init}} yet}}
			{{sdk return code row\|NOT_SUPPORTED \|vp_wait is not supported by this instance, for example a custom vp_net_config was passed to {{sdk method\|create}}}}
			{{sdk return code row\|RECURSIVE_WAIT \|vp_wait was called recursively on the same instance}}
			{{sdk return code row\|CONNECTION_ERROR \|Waiting for data failed or there are no connections to wait for events on}}
	\|behavior=		\|behavior=
	* This will attempt to send all pending messages and receive all pending data within the given time limit		* This will attempt to send all pending messages and receive all pending data within the given time limit

Edwin: updated syntax highlighting tags

2015-02-06T18:08:23Z

updated syntax highlighting tags

← Older revision		Revision as of 18:08, 6 February 2015
Line 12:		Line 12:
	\|caveats=		\|caveats=
	This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. Doing so is undefined behavior and may break the internal SDK state. For example:		This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. Doing so is undefined behavior and may break the internal SDK state. For example:
	<C>		<syntaxhighlight lang="c">
	...		...
	vp_event_set(instance, VP_EVENT_AVATAR_ADD, event_avatar_add);		vp_event_set(instance, VP_EVENT_AVATAR_ADD, event_avatar_add);
Line 19:		Line 19:
	void event_avatar_add(VPInstance sdk)		void event_avatar_add(VPInstance sdk)
	{		{
	char message[~~100~~];		char message[300];
	sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));		sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
	vp_say(sdk, (char*)&message);		vp_say(sdk, (char*)&message);
	vp_wait(instance, 1000); // Undefined behavior		vp_wait(instance, 1000); // Undefined behavior
	}		}
	</C>		</syntaxhighlight>
	\|seealso=		\|seealso=
	* {{sdk method\|event_set}}		* {{sdk method\|event_set}}
	}}		}}

Roy Curtis: + thread info

2014-04-24T08:45:37Z

+ thread info

← Older revision		Revision as of 08:45, 24 April 2014
Line 7:		Line 7:
	\|behavior=		\|behavior=
	* This will attempt to send all pending messages and receive all pending data within the given time limit		* This will attempt to send all pending messages and receive all pending data within the given time limit
	* All [[:Category:SDK events\|SDK events]] are fired from this method call		* All [[:Category:SDK events\|SDK events]] are fired from this method call. Consequently, events are fired on the same thread as the caller.
	* If a value of {{code\|0}} is passed, it could still fire a number of different events		* If a value of {{code\|0}} is passed, it could still fire a number of different events
	* If there is nothing to handle, it will wait until the time limit. Else, it will return immediately after handling all pending data		* If there is nothing to handle, it will wait until the time limit. Else, it will return immediately after handling all pending data

Roy Curtis: clarification

2013-09-30T00:18:50Z

clarification

← Older revision		Revision as of 00:18, 30 September 2013
Line 1:		Line 1:
	{{sdk method page\|wait\|Pumps incoming and outgoing network ~~activity~~ and fires any ~~world server~~ events. Required for most in-world method calls (e.g. {{sdk method\|say}}) and events to actually happen.		{{sdk method page\|wait\|Pumps incoming and outgoing network traffic and fires any registered events. Required for most in-world method calls (e.g. {{sdk method\|say}}) and events to actually happen.
	\|paramex=1000		\|paramex=1000
	\|parameters=		\|parameters=
Line 6:		Line 6:
	{{sdk return code row\|NOT_INITIALIZED\|SDK not initialized with {{sdk method\|init}} yet}}		{{sdk return code row\|NOT_INITIALIZED\|SDK not initialized with {{sdk method\|init}} yet}}
	\|behavior=		\|behavior=
	* This will ~~only pump for up~~ to the ~~amount of milliseconds, with no predictable count of how much data is sent~~		* This will attempt to send all pending messages and receive all pending data within the given time limit
	* All [[:Category:SDK events\|SDK events]] are fired from this method call		* All [[:Category:SDK events\|SDK events]] are fired from this method call
	* If a value of {{code\|0}} is passed, it ~~will at least pump once or~~ fire ~~any event once~~		* If a value of {{code\|0}} is passed, it could still fire a number of different events
	* If there is nothing ~~left~~ to ~~pump (e~~.~~g. no events to fire or data to send)~~, it will immediately ~~return and not sleep for the remainder of the given time~~		* If there is nothing to handle, it will wait until the time limit. Else, it will return immediately after handling all pending data
	\|caveats=		\|caveats=
	This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. Doing so is undefined behavior and may break the internal SDK state. For example:		This method should never be called inside an event handler originating from a previous {{sdk method\|wait}} call. Doing so is undefined behavior and may break the internal SDK state. For example:
Line 25:		Line 25:
	}		}
	</C>		</C>
			\|seealso=
			* {{sdk method\|event_set}}
	}}		}}

Roy Curtis: Created page with "{{sdk method page|wait|Pumps incoming and outgoing network activity and fires any world server events. Required for most in-world method calls (e.g. {{sdk method|say}}) and ev..."

2013-09-29T23:26:55Z

Created page with "{{sdk method page|wait|Pumps incoming and outgoing network activity and fires any world server events. Required for most in-world method calls (e.g. {{sdk method|say}}) and ev..."

New page

{{sdk method page|wait|Pumps incoming and outgoing network activity and fires any world server events. Required for most in-world method calls (e.g. {{sdk method|say}}) and events to actually happen.
|paramex=1000
|parameters=
{{sdk parameter row|int|milliseconds|Maximum amount of time to pump (in milliseconds)}}
|returncodes=
{{sdk return code row|NOT_INITIALIZED|SDK not initialized with {{sdk method|init}} yet}}
|behavior=
* This will only pump for up to the amount of milliseconds, with no predictable count of how much data is sent
* All [[:Category:SDK events|SDK events]] are fired from this method call
* If a value of {{code|0}} is passed, it will at least pump once or fire any event once
* If there is nothing left to pump (e.g. no events to fire or data to send), it will immediately return and not sleep for the remainder of the given time
|caveats=
This method should never be called inside an event handler originating from a previous {{sdk method|wait}} call. Doing so is undefined behavior and may break the internal SDK state. For example:
<C>
...
vp_event_set(instance, VP_EVENT_AVATAR_ADD, event_avatar_add);
while(vp_wait(instance, 1000) == 0){}
...
void event_avatar_add(VPInstance sdk)
{
char message[100];
sprintf((char*)&message, "Hello, %s!", vp_string(sdk, VP_AVATAR_NAME));
vp_say(sdk, (char*)&message);
vp_wait(instance, 1000); // Undefined behavior
}
</C>
}}