KS.Reactor.ksAuthenticationResult Struct Reference

Authentication result returned by user authentication functions. More...

Public Member Functions
	ksAuthenticationResult (uint code, params ksMultiType[] data)
	Constructor More...
override string	ToString ()
	Converts the authentication result to a string. More...

Properties
uint	Code [get]
	Custom status code. More...
ksMultiType[]	Data [get]
	Custom response data. More...

Detailed Description

Authentication result returned by user authentication functions.

Authentication passes if Code is zero. If there are multiple authentication functions, if any of them return a non-zero code, authentication fails.

Constructor & Destructor Documentation

ksAuthenticationResult()

KS.Reactor.ksAuthenticationResult.ksAuthenticationResult	(	uint	code,
		params ksMultiType[]	data
	)

Constructor

Parameters

code	Custom status code. Non-zero to fail authentication.
data	Custom response data.

Member Function Documentation

ToString()

override string KS.Reactor.ksAuthenticationResult.ToString

(

)

Converts the authentication result to a string.

Returns

String representation of the authentication result.

Property Documentation

Code

uint KS.Reactor.ksAuthenticationResult.Code

get

Custom status code.

Non-zero values will fail authentication. If authentication fails because the connection limit is reached, this is the connection limit.

Data

ksMultiType [] KS.Reactor.ksAuthenticationResult.Data

get

Custom response data.

If there are multiple authentication functions and one of them fails, this is the response data from the one that failed. If there are multiple authentication functions that return different response data and authentication passes, all the data values are appended into one array.