Vp connect universe - Revision history

Sleepy E at 20:16, 1 August 2018

2018-08-01T20:16:00Z

← Older revision		Revision as of 20:16, 1 August 2018
Line 1:		Line 1:
	{{Sdk method page\|connect_universe\|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and ~~connects to any~~ world.		{{Sdk method page\|connect_universe\|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and entering a world.
	\|paramex="universe.virtualparadise.org", 57000		\|paramex="universe.virtualparadise.org", 57000
	\|parameters=		\|parameters=
	{{sdk parameter row\|string\|host\|Host address of server to connect to; ~~typically~~ {{code\|"universe.virtualparadise.org"}}}}		{{sdk parameter row\|string\|host\|Host address of server to connect to; currently {{code\|"universe.virtualparadise.org"}}. IP addresses in dotted quad are also valid (e.g. the string "10.0.0.1").}}
	{{sdk parameter row\|int \|port\|TCP port of remote server; ~~typically~~ {{code\|57000}}}}		{{sdk parameter row\|int \|port\|TCP port of remote server; currently {{code\|57000}}}}
	\|returncodes=		\|returncodes=
	{{sdk return code row\|~~connection_error~~\|Error connecting to the universe server}}		{{sdk return code row\|CONNECTION_ERROR\|Error connecting to the universe server}}
			{{sdk return code row\|TIMEOUT \|It took too long to connect or get a response from the server}}
	\|behavior=		\|behavior=
	* If a {{sdk callback\|connect_universe}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.		* If a {{sdk callback\|connect_universe}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.
	\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.		\|caveats=
			* To disconnect from a universe, {{sdk method\|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.
			* {{code\|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=		\|examples=
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
Line 14:		Line 18:

	rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000);		rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000);
	if(rc)		if (rc)
	printf("Couldn't connect to universe(reason %d)", rc);		printf("Couldn't connect to universe (reason %d)", rc);
	</syntaxhighlight>		</syntaxhighlight>
	\|seealso=		\|seealso=

Sleepy E at 19:38, 16 December 2016

2016-12-16T19:38:30Z

← Older revision		Revision as of 19:38, 16 December 2016
Line 2:		Line 2:
	\|paramex="universe.virtualparadise.org", 57000		\|paramex="universe.virtualparadise.org", 57000
	\|parameters=		\|parameters=
	{{sdk parameter row\|string\|host\|~~Hostname~~ of ~~uniserver~~; typically {{code\|"universe.virtualparadise.org"}}}}		{{sdk parameter row\|string\|host\|Host address of server to connect to; typically {{code\|"universe.virtualparadise.org"}}}}
	{{sdk parameter row\|int \|port\|~~Port~~ of ~~uniserver~~; typically {{code\|57000}}}}		{{sdk parameter row\|int \|port\|TCP port of remote server; typically {{code\|57000}}}}
	\|returncodes=		\|returncodes=
	{{sdk return code row\|~~NOT_INITIALIZED\|SDK not initialized with {{sdk method\|init}} yet}}~~		{{sdk return code row\|connection_error\|Error connecting to the universe server}}
	~~{{sdk return code row\|CONNECTION_ERROR~~\|Error connecting to the universe server}}
	\|behavior=		\|behavior=
	* If a {{sdk callback\|~~CONNECT_UNIVERSE~~}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.		* If a {{sdk callback\|connect_universe}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.
	\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.		\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.
	\|examples=		\|examples=
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	int rc;		int rc;
	~~if(~~rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))
	printf("~~Error connecting~~ to universe (reason %d)\n", rc);		rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000);
			if(rc)
			printf("Couldn't connect to universe(reason %d)", rc);
	</syntaxhighlight>		</syntaxhighlight>
	\|seealso=		\|seealso=

Sleepy E: Callback

2016-12-13T21:26:40Z

Callback

← Older revision		Revision as of 21:26, 13 December 2016
Line 7:		Line 7:
	{{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\|CONNECTION_ERROR\|Error connecting to the universe server}}		{{sdk return code row\|CONNECTION_ERROR\|Error connecting to the universe server}}
			\|behavior=
			* If a {{sdk callback\|CONNECT_UNIVERSE}} callback is set this function will return immediately and return the result using the callback, otherwise it will call {{sdk method\|wait}} in a loop until done.
	\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.		\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.
	\|examples=		\|examples=
Line 15:		Line 17:
	</syntaxhighlight>		</syntaxhighlight>
	\|seealso=		\|seealso=
			* {{sdk callback\|CONNECT_UNIVERSE}}
	* {{sdk method\|destroy}}		* {{sdk method\|destroy}}
	* {{sdk method\|login}}		* {{sdk method\|login}}
	}}		}}

Edwin: updated syntax highlighting tags

2015-02-06T18:00:11Z

updated syntax highlighting tags

← Older revision		Revision as of 18:00, 6 February 2015
Line 1:		Line 1:
	{{~~sdk~~ method page\|connect_universe\|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and connects to any world.		{{Sdk method page\|connect_universe\|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and connects to any world.
	\|paramex="universe.virtualparadise.org", 57000		\|paramex="universe.virtualparadise.org", 57000
	\|parameters=		\|parameters=
Line 9:		Line 9:
	\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.		\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.
	\|examples=		\|examples=
	<C>		<syntaxhighlight lang="c">
	int rc;		int rc;
	if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))		if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))
	printf("Error connecting to universe (reason %d)\n", rc);		printf("Error connecting to universe (reason %d)\n", rc);
	</C>		</syntaxhighlight>
	\|seealso=		\|seealso=
	* {{sdk method\|destroy}}		* {{sdk method\|destroy}}
	* {{sdk method\|login}}		* {{sdk method\|login}}
	}}		}}

Roy Curtis: method templates

2013-09-30T15:01:01Z

method templates

← Older revision		Revision as of 15:01, 30 September 2013
Line 15:		Line 15:
	</C>		</C>
	\|seealso=		\|seealso=
	* ~~[[vp_destroy]]~~		* {{sdk method\|destroy}}
	* ~~[[vp_login]]~~		* {{sdk method\|login}}
	}}		}}

Roy Curtis: new page

2013-09-29T15:13:39Z

new page

← Older revision		Revision as of 15:13, 29 September 2013
Line 1:		Line 1:
	~~<C>int vp_connect_universe(VPInstance~~ instance~~, char* host, int port)</C>~~		{{sdk method page\|connect_universe\|Connects an instance to a [[universe]] server. Required before an instance log in with user credentials and connects to any world.
			\|paramex="universe.virtualparadise.org", 57000
	~~== Description ==~~		\|parameters=
	~~Connects~~ to a universe server.		{{sdk parameter row\|string\|host\|Hostname of uniserver; typically {{code\|"universe.virtualparadise.org"}}}}
			{{sdk parameter row\|int \|port\|Port of uniserver; typically {{code\|57000}}}}
	~~== Callback =~~=		\|returncodes=
	~~None~~		{{sdk return code row\|NOT_INITIALIZED\|SDK not initialized with {{sdk method\|init}} yet}}
			{{sdk return code row\|CONNECTION_ERROR\|Error connecting to the universe server}}
	~~== Notes ==~~		\|caveats=To disconnect from a universe, {{sdk method\|destroy}} must be called.
	~~None~~		\|examples=
			<C>
	~~== Arguments =~~=		int rc;
	;~~instance:The SDK instance with which to connect~~.
	~~;host:Host address of the server to which the SDK should connect~~.
	~~;port:TCP~~ port of ~~the remove server.~~

	~~== Argument attributes =~~=
	~~None~~

	~~== Return values ==~~
	~~;[[SDK_Reason_Codes#VP_RC_SUCCESS~~\|~~VP_RC_SUCCESS]]~~
	~~;[[SDK_Reason_Codes#VP_RC_NOT_INITIALIZED~~\|~~VP_RC_NOT_INITIALIZED]]~~
	~~;[[SDK_Reason_Codes#VP_RC_CONNECTION_ERROR~~\|~~VP_RC_CONNECTION_ERROR]]:There was an error~~ connecting to the server.

	=~~= Returned attributes ==~~
	~~None~~

	~~== Example =~~=
	<C>int rc;
	if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))		if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))
	printf("Error connecting to universe (reason %d)\n", rc);</C>		printf("Error connecting to universe (reason %d)\n", rc);
			</C>
	~~== See also =~~=		\|seealso=
	* [[vp_destroy]]		* [[vp_destroy]]
	* [[vp_login]]		* [[vp_login]]
			}}
	~~[[Category: SDK]]~~

Legion: +cat Category: SDK

2012-07-29T20:13:16Z

+cat Category: SDK

← Older revision		Revision as of 20:13, 29 July 2012
Line 34:		Line 34:
	* [[vp_destroy]]		* [[vp_destroy]]
	* [[vp_login]]		* [[vp_login]]

			[[Category: SDK]]

Oliver: Created page.

2012-06-17T15:05:51Z

Created page.

New page

<C>int vp_connect_universe(VPInstance instance, char* host, int port)</C>

== Description ==
Connects to a universe server.

== Callback ==
None

== Notes ==
None

== Arguments ==
;instance:The SDK instance with which to connect.
;host:Host address of the server to which the SDK should connect.
;port:TCP port of the remove server.

== Argument attributes ==
None

== Return values ==
;[[SDK_Reason_Codes#VP_RC_SUCCESS|VP_RC_SUCCESS]]
;[[SDK_Reason_Codes#VP_RC_NOT_INITIALIZED|VP_RC_NOT_INITIALIZED]]
;[[SDK_Reason_Codes#VP_RC_CONNECTION_ERROR|VP_RC_CONNECTION_ERROR]]:There was an error connecting to the server.

== Returned attributes ==
None

== Example ==
<C>int rc;
if(rc = vp_connect_universe(instance, "universe.virtualparadise.org", 57000))
printf("Error connecting to universe (reason %d)\n", rc);</C>

== See also ==
* [[vp_destroy]]
* [[vp_login]]