Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Security.PrefetchSocketPolicy

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function PrefetchSocketPolicy(ip: string, atPort: int, timeout: int = 3000): bool;
public static bool PrefetchSocketPolicy(string ip, int atPort, int timeout = 3000);

Parameters

ip IP address of server.
atPort Port from where socket policy is read.
timeout Time to wait for response.

Description

Prefetch the webplayer socket security policy from a non-default port number.

Socket connections attempted in a webplayer need to be validated by a socket policy. When the policy is hosted on a port different than the default port number (843) it needs to be explicitly fetched with this API call before any socket connections are attempted. The timeout argument is in milliseconds.

The return value indicates if a policy was successfully retrieved or not.

Note that web player is not supported from 5.4.0.