nn::ac Namespace Reference

Auto Connect API, used for managing and connecting to internet connection profiles. More...

Namespaces
	detail
	C++ linkage for the autoconnect API, see nn::ac for use.

Typedefs
typedef uint32_t	ConfigIdNum
	An ID number representing a network configuration. More...

Functions
static nn::Result	Initialize ()
	Initialise the Auto Connect library. More...
static void	Finalize ()
	Cleanup the Auto Connect library. More...
static nn::Result	GetStartupId (ConfigIdNum *id)
	Gets the default connection configuration id. More...
static nn::Result	Connect ()
static nn::Result	ConnectAsync ()
static nn::Result	Close ()
static nn::Result	GetCloseStatus ()
static nn::Result	Connect (ConfigIdNum id)
	Connects to a network, using the configuration represented by the given ConfigIdNum. More...
static nn::Result	GetAssignedAddress (uint32_t *ip)
	Gets the IP address assosciated with the currently active connection. More...

Detailed Description

Auto Connect API, used for managing and connecting to internet connection profiles.

Typedef Documentation

ConfigIdNum

typedef uint32_t ConfigIdNum

An ID number representing a network configuration.

These are the same IDs as shown in System Settings' Connection List.

Definition at line 27 of file ac_cpp.h.

Function Documentation

Initialize()

static nn::Result nn::ac::Initialize ( void  )

inlinestatic

Initialise the Auto Connect library.

Call this function before any other nn::ac functions.

Returns

A Result - see nn::Result::IsSuccess and nn::Result::IsFailure.

See also

• Finalize

Definition at line 64 of file ac_cpp.h.

Finalize()

static void nn::ac::Finalize ( void  )

inlinestatic

Cleanup the Auto Connect library.

Do not call any nn::ac functions (other than Initialize) after calling this function.

See also

• Initialize

Definition at line 77 of file ac_cpp.h.

GetStartupId()

static nn::Result nn::ac::GetStartupId ( ConfigIdNum *  id )

inlinestatic

Gets the default connection configuration id.

This is the default as marked in System Settings.

Parameters

id	A pointer to an ConfigIdNum to write the config ID to. Must not be a nullptr.

Returns

A Result - see nn::Result::IsSuccess and nn::Result::IsFailure.

Definition at line 96 of file ac_cpp.h.

Connect() [1/2]

static nn::Result nn::ac::Connect ( )

inlinestatic

Definition at line 102 of file ac_cpp.h.

ConnectAsync()

static nn::Result nn::ac::ConnectAsync ( )

inlinestatic

Definition at line 108 of file ac_cpp.h.

Close()

static nn::Result nn::ac::Close ( )

inlinestatic

Definition at line 114 of file ac_cpp.h.

GetCloseStatus()

static nn::Result nn::ac::GetCloseStatus ( )

inlinestatic

Definition at line 120 of file ac_cpp.h.

Connect() [2/2]

static nn::Result nn::ac::Connect ( ConfigIdNum  id )

inlinestatic

Connects to a network, using the configuration represented by the given ConfigIdNum.

Parameters

id	The ConfigIdNum representing the network to connect to.

Returns

A Result - see nn::Result::IsSuccess and nn::Result::IsFailure.

Definition at line 137 of file ac_cpp.h.

GetAssignedAddress()

static nn::Result nn::ac::GetAssignedAddress ( uint32_t *  ip )

inlinestatic

Gets the IP address assosciated with the currently active connection.

Parameters

ip	A pointer to write the IP address to, in numerical form.

Returns

A Result - see nn::Result::IsSuccess and nn::Result::IsFailure.

Definition at line 155 of file ac_cpp.h.