A class for representing a wireless network. More...
#import <Network/Network.h>
Inheritance diagram for NXWirelessNetwork:
Collaboration diagram for NXWirelessNetwork:
Instance Methods | |
| (NXString *) | - ssid |
| The Service Set Identifier (network name). More... | |
| (NXString *) | - bssid |
| The Basic Service Set Identifier (access point MAC address). More... | |
| (uint8_t) | - channel |
| Primary channel number for this network. More... | |
| (int16_t) | - rssi |
| Received signal strength indicator. More... | |
 Instance Methods inherited from NXObject | |
| (id) | - retain |
| Increases the retain count of the receiver. More... | |
| (void) | - release |
| Decreases the retain count of the receiver. More... | |
| (id) | - autorelease |
| Adds the receiver to the autorelease pool. | |
| Instance Methods inherited from Object | |
| (void) | - dealloc |
| Free resources for an existing instance. | |
| (id) | - init |
| Initialize the instance, after allocation. More... | |
| (Class) | - class |
| Returns the class of the instance. More... | |
| (Class) | - superclass |
| Returns the superclass of the instance. More... | |
| (BOOL) | - isEqual: |
| Compares the receiver to another object for equality. More... | |
| (BOOL) | - isKindOfClass: |
| Returns a Boolean value that indicates whether the receiver is an instance of a given class. More... | |
| (BOOL) | - conformsTo: |
| Checks if the receiver's class conforms to a protocol. More... | |
| (NXString *) | - description |
| Returns a string that represents the instance. More... | |
| Instance Methods inherited from <ObjectProtocol> | |
| (BOOL) | - respondsToSelector: |
| Checks if the receiver responds to a selector. More... | |
Class Methods | |
| (NXWirelessNetwork *) | + networkWithName: |
| Create a wireless network descriptor with the given SSID. More... | |
| Class Methods inherited from NXObject | |
| (id) | + allocWithZone: |
| Allocates a new instance of an object in a specific memory zone. More... | |
| Class Methods inherited from Object | |
| (void) | + initialize |
| Performs one-time initialization for the class. More... | |
| (id) | + alloc |
| Allocate a new class instance. More... | |
| (Class) | + class |
| Returns the class object. More... | |
| (Class) | + superclass |
| Returns the superclass of the class. More... | |
| (const char *) | + name |
| Returns the name of the class. More... | |
| (BOOL) | + conformsTo: |
| Checks if the class conforms to a protocol. More... | |
| (NXString *) | + description |
| Returns a string that represents the class. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from NXObject | |
| id | _zone |
| The memory zone where the object is allocated. | |
| unsigned short | _retain |
| The retain count of the object. | |
| id | _next |
| The next object in an autorelease pool. | |
| Protected Attributes inherited from Object | |
| Class | isa |
| A pointer to the object's class structure. More... | |
Detailed Description
A class for representing a wireless network.
This class provides an interface for accessing information about a specific Wi-Fi network, including its SSID, signal strength, and security type.
It's used both for discovering networks, connecting to networks and reporting on network status.
- Examples:
- examples/Network/ntp/main.m, and examples/Network/scan/main.m.
Definition at line 23 of file NXWirelessNetwork.h.
Method Documentation
◆ bssid()
| - (NXString *) bssid |
The Basic Service Set Identifier (access point MAC address).
- Returns
- BSSID as an NXString (implementation-defined formatting; typically a 6‑octet hexadecimal string such as "AA:BB:CC:DD:EE:FF"). If not defined, will return NULL.
◆ channel()
| - (uint8_t) channel |
Primary channel number for this network.
- Returns
- The Wi‑Fi channel number, or zero if not defined.
◆ networkWithName:()
| + (NXWirelessNetwork *) networkWithName: | (id< NXConstantStringProtocol >) | name |
Create a wireless network descriptor with the given SSID.
- Parameters
-
name The SSID string (conforming to NXConstantStringProtocol). Typical SSIDs are 0–32 bytes long.
- Returns
- A new NXWirelessNetwork instance initialized with the provided name, or nil on error.
◆ rssi()
| - (int16_t) rssi |
Received signal strength indicator.
- Returns
- RSSI in dBm (typically negative; values closer to zero indicate stronger signal). Returns zero if not defined.
◆ ssid()
The documentation for this class was generated from the following file:
- include/Network/NXWirelessNetwork.h