Difference between revisions of "Network Interface services"

From Nintendo Switch Brew
Jump to navigation Jump to search
Line 108: Line 108:
  
 
=== IRequest ===
 
=== IRequest ===
−
This is "nn::nifm::detail::IRequest".
+
This is "nn::nifm::detail::IRequest". This represents an application or sysmodule's request to bring a network up.
  
 
{| class="wikitable" border="1"
 
{| class="wikitable" border="1"
Line 114: Line 114:
 
! Cmd || Name
 
! Cmd || Name
 
|-  
 
|-  
−
| 0 || GetRequestState
+
| 0 || [[#GetRequestState]]
 
|-
 
|-
−
| 1 || GetResult
+
| 1 || [[#GetResult]]
 
|-
 
|-
−
| 2 || GetSystemEventReadableHandles
+
| 2 || [[#GetSystemEventReadableHandles]]
 
|-
 
|-
−
| 3 || Cancel
+
| 3 || [[#Cancel]]
 
|-
 
|-
−
| 4 || Submit
+
| 4 || [[#Submit]]
 
|-
 
|-
 
| 5 || SetRequirement
 
| 5 || SetRequirement
Line 134: Line 134:
 
| 10 || SetRejectable
 
| 10 || SetRejectable
 
|-
 
|-
−
| 11 || SetConnectionConfirmationOption
+
| 11 || [[#SetConnectionConfirmationOption]]
 
|-
 
|-
−
| 12 || SetPersistent
+
| 12 || [[#SetPersistent]]
 
|-
 
|-
 
| 13 || SetInstant
 
| 13 || SetInstant
Line 165: Line 165:
 
|-
 
|-
 
|}
 
|}
 +
 +
==== GetRequestState ====
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Number || Description
 +
|-
 +
| 1 || Not yet submitted or error
 +
|-
 +
| 2 || Pending (sdk calls this OnHold)
 +
|-
 +
| 3 || Connected
 +
|-
 +
|}
 +
 +
==== GetResult ====
 +
 +
If the request enters state 1, this command can be used to determine why. It responds with the nice networking error codes that there are support pages for.
 +
 +
==== GetSystemEventReadableHandles ====
 +
 +
Returns two event handles. The first one signals when the RequestState changes.
 +
 +
==== Cancel ====
 +
 +
Cancels the request to bring the network up.
 +
 +
==== Submit ====
 +
 +
Submits the request to bring the network up. Call this after configuring the request.
 +
 +
==== SetConnectionConfirmationOption ====
 +
 +
Set how to verify the internet connection.
 +
 +
{| class="wikitable" border="1"
 +
|-
 +
! Option || Description
 +
|-
 +
| 0 ||
 +
|-
 +
| 1 ||
 +
|-
 +
| 2 || "Local" network (does not check for working DNS)
 +
|-
 +
| 3 ||
 +
|-
 +
| 4 || Default
 +
|-
 +
| 5 ||
 +
|-
 +
|}
 +
 +
==== SetPersistent ====
 +
 +
If this is set, when the network connection is lost, rather than causing the request to enter state 1, it will instead enter state 2 and attempt to bring the network back up again.
  
 
=== INetworkProfile ===
 
=== INetworkProfile ===

Revision as of 17:53, 12 October 2018

nifm:a, nifm:s, nifm:u

These are "nn::nifm::detail::IStaticService".

Cmd Name Notes
4 CreateGeneralServiceOld ([1.0.0-2.3.0] CreateGeneralService) Returns an #IGeneralService.
5 [3.0.0+] CreateGeneralService Returns an #IGeneralService.

IGeneralService

This is "nn::nifm::detail::IGeneralService".

Cmd Name Notes
1 GetClientId
2 CreateScanRequest Returns an #IScanRequest.
4 CreateRequest Returns an #IRequest.
5 GetCurrentNetworkProfile
6 EnumerateNetworkInterfaces
7 EnumerateNetworkProfiles
8 GetNetworkProfile
9 SetNetworkProfile
10 RemoveNetworkProfile
11 GetScanDataOld ([1.0.0-3.0.2] GetScanData)
12 GetCurrentIpAddress
13 GetCurrentAccessPointOld ([1.0.0-3.0.2] GetCurrentAccessPoint)
14 CreateTemporaryNetworkProfile Returns an #INetworkProfile.
15 GetCurrentIpConfigInfo
16 SetWirelessCommunicationEnabled
17 IsWirelessCommunicationEnabled
18 GetInternetConnectionStatus
19 SetEthernetCommunicationEnabled
20 IsEthernetCommunicationEnabled
21 IsAnyInternetRequestAccepted
22 IsAnyForegroundRequestAccepted
23 PutToSleep
24 WakeUp
25 GetSsidListVersion
26 SetExclusiveClient
27 GetDefaultIpSetting
28 SetDefaultIpSetting
29 SetWirelessCommunicationEnabledForTest
30 SetEthernetCommunicationEnabledForTest
31 [2.0.0+] GetTelemetorySystemEventReadableHandle
32 [2.0.0+] GetTelemetryInfo
33 [2.0.0+] ConfirmSystemAvailability
34 [4.0.0+] SetBackgroundRequestEnabled
35 [4.0.0+] GetScanData
36 [4.0.0+] GetCurrentAccessPoint
37 [4.0.0+] Shutdown

IScanRequest

This is "nn::nifm::detail::IScanRequest".

Cmd Name
0 Submit
1 IsProcessing
2 GetResult
3 GetSystemEventReadableHandle

IRequest

This is "nn::nifm::detail::IRequest". This represents an application or sysmodule's request to bring a network up.

Cmd Name
0 #GetRequestState
1 #GetResult
2 #GetSystemEventReadableHandles
3 #Cancel
4 #Submit
5 SetRequirement
6 SetRequirementPreset
8 SetPriority
9 SetNetworkProfileId
10 SetRejectable
11 #SetConnectionConfirmationOption
12 #SetPersistent
13 SetInstant
14 SetSustainable
15 SetRawPriority
16 SetGreedy
17 SetSharable
18 SetRequirementByRevision
19 GetRequirement
20 GetRevision
21 GetAppletInfo
22 GetAdditionalInfo
23 SetKeptInSleep
24 RegisterSocketDescriptor
25 UnregisterSocketDescriptor

GetRequestState

Number Description
1 Not yet submitted or error
2 Pending (sdk calls this OnHold)
3 Connected

GetResult

If the request enters state 1, this command can be used to determine why. It responds with the nice networking error codes that there are support pages for.

GetSystemEventReadableHandles

Returns two event handles. The first one signals when the RequestState changes.

Cancel

Cancels the request to bring the network up.

Submit

Submits the request to bring the network up. Call this after configuring the request.

SetConnectionConfirmationOption

Set how to verify the internet connection.

Option Description
0
1
2 "Local" network (does not check for working DNS)
3
4 Default
5

SetPersistent

If this is set, when the network connection is lost, rather than causing the request to enter state 1, it will instead enter state 2 and attempt to bring the network back up again.

INetworkProfile

This is "nn::nifm::detail::INetworkProfile".

Cmd Name
0 Update
1 PersistOld ([1.0.0-2.3.0] Persist)
2 [3.0.0+] Persist
Retrieved from "https://switchbrew.org/w/index.php?title=Network_Interface_services&oldid=5194"