nn::uds::CTR::DisallowToConnect Function

Syntax

nn::Result DisallowToConnect(
     bool isDisallowToReconnect = false
);

Parameters

Name Description
in isDisallowToReconnect If set to false, only the clients that were disconnected after calling this function can reconnect.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Process was successful.
ResultNotInitialized The library is not initialized. Execute the Initialize function.
ResultInvalidState Not in an executable state. Returned when executed in a state other than master.
ResultWirelessOff Entered wireless-disabled mode. Re-initialization is required.
A value other than the above Failed for reasons other than those given above.

Description

Disallows client nodes to connect to the network. Does not affect clients currently connected.

This connection denying feature was assumed for use when you want to deny new competing clients from connecting. When you want to allow connections once again, execute the AllowToConnect function. Only the master can run this function.

This function is thread-safe.

Revision History

2011/09/07
Standardized notation for wireless-disabled mode.
2011/03/08
Added a link to Initialize in Return Values.
2010/10/15
Initial version.

CONFIDENTIAL