maxon::URLFLAGS Namespace Reference

Detailed Description

Parameters for UrlInterface::SetData(), UrlInterface::GetData().

Namespaces
	ASSETREPOSITORYCATEGORY_ENUM

Functions
	MAXON_ATTRIBUTE (Id, ASSETREPOSITORYTYPE, "net.maxon.url.assetdatabasetype")
	MAXON_ATTRIBUTE (InternedId, ASSETREPOSITORYCATEGORY, "net.maxon.url.repositorycategory")
	MAXON_ATTRIBUTE (String, WATCHFOLDERNAME, "net.maxon.url.watchfolderstring")
	MAXON_ATTRIBUTE (BackgroundEntryTuple, BACKGROUNDJOB, "net.maxon.url.backgroundjob")
	MAXON_ATTRIBUTE (Bool, DUMMY, "net.maxon.dummy")
	MAXON_ATTRIBUTE (Bool, PIPE_CREATE, 'pipc')
	MAXON_ATTRIBUTE (Bool, UNBUFFERED_FILE, "net.maxon.url.unbuffered_file")
	MAXON_ATTRIBUTE (TimeValue, NETWORK_CONNECTTIMEOUT, "net.maxon.url.network_connecttimeout")
	MAXON_ATTRIBUTE (TimeValue, NETWORK_SESSIONTIMEOUT, "net.maxon.url.network_sessiontimeout")
	MAXON_ATTRIBUTE (String, USERNAME, "net.maxon.url.username")
	MAXON_ATTRIBUTE (String, USERPASSWORD, "net.maxon.url.userpassword")
	MAXON_ATTRIBUTE (String, QUERY, "net.maxon.url.query")
	MAXON_ATTRIBUTE (String, FRAGMENT, "net.maxon.url.fragment")
	MAXON_ATTRIBUTE (Bool, CACHE_IN_RAM, "net.maxon.url.cache_in_ram")
	MAXON_ATTRIBUTE (DelegateBase, FTPS_FINGERPRINT, "net.maxon.url.ftps_fingerprint")
	MAXON_ATTRIBUTE (URLCOMPARE, PRIVATE_FORCECOMPAREMODE, "net.maxon.url.private_forcecomparemode")
	MAXON_ATTRIBUTE (CryptoKey, CRYPTO_KEY, 'cryp')
	MAXON_ATTRIBUTE (Float, IMAGESEQUENCE_FPS, "net.maxon.url.imagesequence_fps")
	MAXON_ATTRIBUTE (Int, IMAGESEQUENCE_FIRSTFRAME, "net.maxon.url.imagesequence_firstframe")
	MAXON_ATTRIBUTE (Int, IMAGESEQUENCE_LASTFRAME, "net.maxon.url.imagesequence_lastframe")
	MAXON_ATTRIBUTE (NetworkConnectionRef, TCP_NETWORKCONNECTION_REF, 'tcpr')
	MAXON_ATTRIBUTE (Int64, TCP_NETWORKCONNECTION_KNOWNSIZE, 'tcps')
	MAXON_ATTRIBUTE (SSLPROTOCOLVERSION, SSLPROTOCOL, "net.maxon.url.sslprotocol")
	MAXON_ATTRIBUTE (SSLCERTREQUIREMENTS, SSLREQUIREMENTS, "net.maxon.url.sslrequirements")
	MAXON_ATTRIBUTE (Url, USECUSTOMCLIENTCERTIFICATE, "net.maxon.url.usecustomclientcertificate")
	MAXON_ATTRIBUTE (Bool, NETWORK_SUPRESS_PROXY, "net.maxon.url.network_supress_proxy")
	MAXON_ATTRIBUTE (DataDictionary, HTTP_ADDITIONAL_REQUEST_HEADER, "net.maxon.url.http_additional_request_header")
	MAXON_ATTRIBUTE (DataDictionary *, HTTP_RESPONSE_HEADER, "net.maxon.url.http_response_header")
	MAXON_ATTRIBUTE (Bool, HTTP_FOLLOWMOVEDFILES, "net.maxon.url.http_followmovedfiles")
	MAXON_ATTRIBUTE (HTTPMETHOD, HTTP_POSTMETHOD, "net.maxon.url.http_postmethod")
	MAXON_ATTRIBUTE (CString, HTTP_POSTDATA, "net.maxon.url.http_postdata")
	MAXON_ATTRIBUTE (Bool, HTTP_NO_PROXY_CACHING, "net.maxon.url.http_no_proxy_caching")
	MAXON_ATTRIBUTE (Bool, HTTP_DISALLOW_GZIP, "net.maxon.url.http_disallow_gzip")
	MAXON_ATTRIBUTE (Bool, HTTP_NO_KEEP_ALIVE, "net.maxon.url.http_no_keep_alive")

Function Documentation

MAXON_ATTRIBUTE() [1/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Id	,
		ASSETREPOSITORYTYPE	,
		"net.maxon.url.assetdatabasetype"
	)

Forces the repository to treat this url as watch folder repository.

MAXON_ATTRIBUTE() [2/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	InternedId	,
		ASSETREPOSITORYCATEGORY	,
		"net.maxon.url.repositorycategory"
	)

category of the repository in the database listview, see ASSETREPOSITORYCATEGORY_ENUM

MAXON_ATTRIBUTE() [3/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	String	,
		WATCHFOLDERNAME	,
		"net.maxon.url.watchfolderstring"
	)

Forces the repository name.

MAXON_ATTRIBUTE() [4/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	BackgroundEntryTuple	,
		BACKGROUNDJOB	,
		"net.maxon.url.backgroundjob"
	)

Passes the background job through the url.

MAXON_ATTRIBUTE() [5/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		DUMMY	,
		"net.maxon.dummy"
	)

dummy value to trigger source processor to create restriction class

MAXON_ATTRIBUTE() [6/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		PIPE_CREATE	,
		'pipc'
	)

Set to true, if the named pipe should be created, otherwise an existing pipe will be used. This flag is ignored for unnamed pipes. Depending on the OS the name might be modified.

MAXON_ATTRIBUTE() [7/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		UNBUFFERED_FILE	,
		"net.maxon.url.unbuffered_file"
	)

Set to true, if file should be unbuffered.

MAXON_ATTRIBUTE() [8/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	TimeValue	,
		NETWORK_CONNECTTIMEOUT	,
		"net.maxon.url.network_connecttimeout"
	)

Connection time out for network connections.

MAXON_ATTRIBUTE() [9/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	TimeValue	,
		NETWORK_SESSIONTIMEOUT	,
		"net.maxon.url.network_sessiontimeout"
	)

Session time out for network connections.

MAXON_ATTRIBUTE() [10/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	String	,
		USERNAME	,
		"net.maxon.url.username"
	)

User name for the the url. RFC3986 (7.5) says Url producers should not provide a URL that contains a username or password that is intended to be secret. URIs are frequently displayed by browsers, stored in clear text bookmarks, and logged by user agent history and intermediary applications (proxies). However, this feature is still used and that's why this is supported.

MAXON_ATTRIBUTE() [11/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	String	,
		USERPASSWORD	,
		"net.maxon.url.userpassword"
	)

Password for the url. RFC3986 (7.5) says Url producers should not provide a URL that contains a username or password that is intended to be secret. URIs are frequently displayed by browsers, stored in clear text bookmarks, and logged by user agent history and intermediary applications (proxies). However, this feature is still used and that's why this is supported.

MAXON_ATTRIBUTE() [12/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	String	,
		QUERY	,
		"net.maxon.url.query"
	)

Serves to identify a resource within the scope of the url scheme e.g. "date=today" or "subject=Topic".

MAXON_ATTRIBUTE() [13/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	String	,
		FRAGMENT	,
		"net.maxon.url.fragment"
	)

Holds additional identifying information that provides direction to a secondary resource, e.g., a section heading (in an article) identified by the remainder of the URI. When the primary resource is an HTML document, the fragment is often an id attribute of a specific element and web browsers will make sure this element is visible. For example for MIME text/html pages such as http://www.example.org/foo.html#bar the fragment refers to the element with id="bar".

MAXON_ATTRIBUTE() [14/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		CACHE_IN_RAM	,
		"net.maxon.url.cache_in_ram"
	)

URLSCHEME_CACHE, If true, the cache is created in the RAM, otherwise in the machines temp directory on harddrive.

MAXON_ATTRIBUTE() [15/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	DelegateBase	,
		FTPS_FINGERPRINT	,
		"net.maxon.url.ftps_fingerprint"
	)

URLSCHEME_FTPS, Optional callback Bool(const String& fingerprint) which is triggered when the connection was established. Return true if the fingerprint is valid, otherwise return false to abort the connection.

MAXON_ATTRIBUTE() [16/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	URLCOMPARE	,
		PRIVATE_FORCECOMPAREMODE	,
		"net.maxon.url.private_forcecomparemode"
	)

MAXON_ATTRIBUTE() [17/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	CryptoKey	,
		CRYPTO_KEY	,
		'cryp'
	)

Data for encryption class within Urls.

See also

CryptoKey.

MAXON_ATTRIBUTE() [18/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Float	,
		IMAGESEQUENCE_FPS	,
		"net.maxon.url.imagesequence_fps"
	)

Defines the fps of an image sequence.

MAXON_ATTRIBUTE() [19/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Int	,
		IMAGESEQUENCE_FIRSTFRAME	,
		"net.maxon.url.imagesequence_firstframe"
	)

(optional) Defines the first frame of the image sequence.

MAXON_ATTRIBUTE() [20/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Int	,
		IMAGESEQUENCE_LASTFRAME	,
		"net.maxon.url.imagesequence_lastframe"
	)

(optional) Defines the last frame of the image sequence.

MAXON_ATTRIBUTE() [21/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	NetworkConnectionRef	,
		TCP_NETWORKCONNECTION_REF	,
		'tcpr'
	)

Reference to a network connection.

MAXON_ATTRIBUTE() [22/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Int64	,
		TCP_NETWORKCONNECTION_KNOWNSIZE	,
		'tcps'
	)

Optional Parameter to set a known size for this stream. NOTOK defines an unknown size.

MAXON_ATTRIBUTE() [23/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	SSLPROTOCOLVERSION	,
		SSLPROTOCOL	,
		"net.maxon.url.sslprotocol"
	)

Sets ssl protocol version for ssl connection.

MAXON_ATTRIBUTE() [24/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	SSLCERTREQUIREMENTS	,
		SSLREQUIREMENTS	,
		"net.maxon.url.sslrequirements"
	)

Sets the required ssl certificate options. The default value is SSLCERTREQUIREMENTS::REQUIRED | SSLCERTREQUIREMENTS::VERIFY_AUTHORITY.

MAXON_ATTRIBUTE() [25/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Url	,
		USECUSTOMCLIENTCERTIFICATE	,
		"net.maxon.url.usecustomclientcertificate"
	)

True if a custom ssl certificate shoudl be used.

MAXON_ATTRIBUTE() [26/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		NETWORK_SUPRESS_PROXY	,
		"net.maxon.url.network_supress_proxy"
	)

Don't use a proxy for this url. This should only be used for very specific reasons (e.g. the internal proxy loader needs to suppress using a proxy)

MAXON_ATTRIBUTE() [27/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	DataDictionary	,
		HTTP_ADDITIONAL_REQUEST_HEADER	,
		"net.maxon.url.http_additional_request_header"
	)

Each entry in the dictionary will be added to the http request in the form "key: value\r\n".

MAXON_ATTRIBUTE() [28/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	DataDictionary *	,
		HTTP_RESPONSE_HEADER	,
		"net.maxon.url.http_response_header"
	)

Writes the response header into the datadictionary.

MAXON_ATTRIBUTE() [29/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		HTTP_FOLLOWMOVEDFILES	,
		"net.maxon.url.http_followmovedfiles"
	)

Set to true if a http connection should follow "301 permanently moved file" and open the moved file instead.

MAXON_ATTRIBUTE() [30/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	HTTPMETHOD	,
		HTTP_POSTMETHOD	,
		"net.maxon.url.http_postmethod"
	)

Set to true if a you want to send a POST request, otherwise GET will be assumed.

MAXON_ATTRIBUTE() [31/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	CString	,
		HTTP_POSTDATA	,
		"net.maxon.url.http_postdata"
	)

If HTTPPOST is true, add additional data. The data needs to be url encoded. Zhe CString needs to be in the format: "<<parameter>>=<<data>>&...".

MAXON_ATTRIBUTE() [32/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		HTTP_NO_PROXY_CACHING	,
		"net.maxon.url.http_no_proxy_caching"
	)

If a proxy Server is used set the "Cache-Control: no-cache".

MAXON_ATTRIBUTE() [33/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		HTTP_DISALLOW_GZIP	,
		"net.maxon.url.http_disallow_gzip"
	)

Set to true, if gzip compression is not allowed.

MAXON_ATTRIBUTE() [34/34]

maxon::URLFLAGS::MAXON_ATTRIBUTE	(	Bool	,
		HTTP_NO_KEEP_ALIVE	,
		"net.maxon.url.http_no_keep_alive"
	)

Set to true, if keep-alive should not be forbidden.