Gocator API
|
Represents a discovery client.
Inherits kObject.
Public Member Functions | |
kStatus | GoDiscovery_Construct (GoDiscovery *discovery, kAlloc allocator) |
Constructs a GoDiscovery object. More... | |
kStatus | GoDiscovery_Enumerate (GoDiscovery discovery, kArrayList infoList) |
Enumerates sensors present in the network. More... | |
kStatus | GoDiscovery_GetAddress (GoDiscovery discovery, k32u deviceId, GoAddressInfo *address) |
Retrieves a sensor's network address settings. More... | |
kStatus | GoDiscovery_SetAddress (GoDiscovery discovery, k32u deviceId, const GoAddressInfo *address) |
Configures a sensor's network address settings. More... | |
kStatus | GoDiscovery_SetEnumHandler (GoDiscovery discovery, GoDiscoveryEnumFx function, kPointer receiver) |
Sets the enumeration callback to be used when background updates are enabled via StartEnum. More... | |
kStatus | GoDiscovery_SetEnumPeriod (GoDiscovery discovery, k64u period) |
Sets the enumeration period that will be used when background updates are enabled via StartEnum. More... | |
kStatus | GoDiscovery_StartEnum (GoDiscovery discovery, kBool waitFirst) |
Starts periodic background discovery enumeration. More... | |
kStatus | GoDiscovery_StopEnum (GoDiscovery discovery) |
Stops periodic background discovery enumeration. More... | |
kStatus GoDiscovery_Construct | ( | GoDiscovery * | discovery, |
kAlloc | allocator | ||
) |
Constructs a GoDiscovery object.
discovery | Receives constructed discovery object. |
allocator | Memory allocator (or kNULL for default) |
kStatus GoDiscovery_Enumerate | ( | GoDiscovery | discovery, |
kArrayList | infoList | ||
) |
Enumerates sensors present in the network.
discovery | Discovery object. |
infoList | List to be populated with sensor descriptors (kArrayList<GoDiscoveryInfo>). |
kStatus GoDiscovery_GetAddress | ( | GoDiscovery | discovery, |
k32u | deviceId, | ||
GoAddressInfo * | address | ||
) |
Retrieves a sensor's network address settings.
This function uses UDP broadcasts; the sensor and can be on a different subnet than the client.
discovery | Discovery object. |
deviceId | Sensor device identifier (serial number). |
address | Receives address information. |
kStatus GoDiscovery_SetAddress | ( | GoDiscovery | discovery, |
k32u | deviceId, | ||
const GoAddressInfo * | address | ||
) |
Configures a sensor's network address settings.
This function uses UDP broadcasts; the sensor and can be on a different subnet than the client.
The sensor will automatically reboot if the address is successfully changed.
discovery | Discovery object. |
deviceId | Sensor device identifier (serial number). |
address | New address information. |
kStatus GoDiscovery_SetEnumHandler | ( | GoDiscovery | discovery, |
GoDiscoveryEnumFx | function, | ||
kPointer | receiver | ||
) |
Sets the enumeration callback to be used when background updates are enabled via StartEnum.
discovery | Discovery object. |
function | Enumeration callback function (or kNULL to unregister). |
receiver | Receiver argument for callback. |
kStatus GoDiscovery_SetEnumPeriod | ( | GoDiscovery | discovery, |
k64u | period | ||
) |
Sets the enumeration period that will be used when background updates are enabled via StartEnum.
discovery | Discovery object. |
period | Enumeration period, in microseconds. |
kStatus GoDiscovery_StartEnum | ( | GoDiscovery | discovery, |
kBool | waitFirst | ||
) |
Starts periodic background discovery enumeration.
discovery | Discovery object. |
waitFirst | kTRUE to block until first enumeration cycle is completed; kFALSE otherwise. |
kStatus GoDiscovery_StopEnum | ( | GoDiscovery | discovery | ) |
Stops periodic background discovery enumeration.
discovery | Discovery object. |