Odniesienie do struktury FlpLocationInterface

Pola danych
Odniesienie do struktury FlpLocationInterface

#include < fused_location.h >

Pola danych

rozmiar_t rozmiar
int(* init )( FlpCallbacks *callbacki)
int(* get_batch_size )()
int(* start_batching )(int id, FlpBatchOptions *opcje)
int(* update_batching_options )(int id, FlpBatchOptions *new_options)
int(* stop_batching )(int id)
próżnia(* posprzątać )()
próżnia(* get_batched_location )(int last_n_locations)
int(* inject_location )( FlpLocation *lokalizacja)
stała nieważna *(* get_extension )(const char *name)
próżnia(* Flush_batched_locations )()

szczegółowy opis

Reprezentuje standardowy interfejs FLP.

Definicja w linii 321 plikufused_location.h .

Dokumentacja terenowa

void(* sprzątanie)()

Zamyka interfejs. Jeśli trwają jakiekolwiek operacje wsadowe, należy je przerwać.

Definicja w linii 398 plikufused_location.h .

void(* Flush_batched_locations)()

Pobierz wszystkie aktualnie zapisane lokalizacje wsadowe i wyczyść bufor. W odpowiedzi MUSI zostać wywołana funkcja flp_location_callback, nawet jeśli nie ma żadnych lokalizacji do opróżnienia (w takim przypadku liczba_lokalizacji powinna wynosić 0). Kolejne wywołania funkcji get_batched_location lub Flush_batched_locations nie powinny zwracać żadnej z lokalizacji zwróconych w tym wywołaniu.

Definicja w linii 436 plikufused_location.h .

int(* get_batch_size)()

Zwróć rozmiar partii (w liczbie obiektów FlpLocation ) dostępny w sprzęcie. Uwaga, różne implementacje sprzętu mogą mieć różne rozmiary próbek. To zwróci liczbę próbek zdefiniowaną w formacie FlpLocation . Będzie to wykorzystane przez górną warstwę do podjęcia decyzji o interwale wsadowym i o tym, czy punkt dostępowy powinien zostać wybudzony, czy nie.

Definicja w linii 343 plikufused_location.h .

void(* get_batched_location)(int last_n_locations)

Uzyskaj połączoną lokalizację, która została wsadowa. flp_location_callback służy do zwracania lokalizacji. Obiekt lokalizacji jest usuwany z bufora tylko wtedy, gdy bufor jest pełny. Nie usuwaj go z bufora tylko dlatego, że został zwrócony za pomocą wywołania zwrotnego. Innymi słowy, gdy nie ma nowego obiektu lokalizacji, dwa wywołania metody get_batched_location(1) powinny zwrócić ten sam obiekt lokalizacji. Parametry: last_n_locations - Liczba lokalizacji do zdobycia. Może to być jeden lub wiele. Jeśli last_n_locations wynosi 1, otrzymasz najnowszą lokalizację znaną sprzętowi.

Definicja w linii 412 plikufused_location.h .

const void*(* get_extension)(const char *name)

Uzyskaj wskaźnik do informacji o rozszerzeniu.

Definicja w linii 427 plikufused_location.h .

int(* init)( FlpCallbacks *callbacki)

Otwiera interfejs i udostępnia procedury wywołania zwrotnego umożliwiające implementację tego interfejsu. Po wywołaniu powinieneś odpowiedzieć, wywołując funkcję flp_capabilities_callback w FlpCallbacks , aby określić możliwości obsługiwane przez twoją implementację.

Definicja w linii 333 plikufused_location.h .

int(* inject_location)( FlpLocation *lokalizacja)

Wstrzykuje bieżącą lokalizację od innego dostawcy lokalizacji. Szerokość i długość geograficzna mierzona jest w stopniach. Oczekiwana dokładność mierzona jest w metrach. Parametry: lokalizacja — wstrzykiwany obiekt lokalizacji. Wartość zwracana: FLP_RESULT_SUCCESS lub FLP_RESULT_ERROR.

Definicja w linii 422 plikufused_location.h .

rozmiar_t rozmiar

ustawiony na sizeof(FlpLocationInterface)

Definicja w linii 325 plikufused_location.h .

int(* start_batching)(int id, FlpBatchOptions *opcje)

Rozpocznij grupowanie lokalizacji. Ten interfejs API jest używany głównie wtedy, gdy punkt dostępowy jest w stanie uśpienia, a urządzenie może grupować lokalizacje w sprzęcie. flp_location_callback służy do zwracania lokalizacji. Gdy bufor jest pełny i zostanie użyty FLP_BATCH_WAKEUP_ON_FIFO_FULL, punkt dostępowy zostanie wybudzony. Kiedy bufor jest pełny i nie ustawiono FLP_BATCH_WAKEUP_ON_FIFO_FULL, najstarszy obiekt lokalizacji jest usuwany. W takim przypadku AP nie zostanie wybudzony. Górna warstwa użyje interfejsu API get_batched_location, aby jawnie zapytać o lokalizację. Jeśli ustawiono FLP_BATCH_CALLBACK_ON_LOCATION_FIX, implementacja wywoła funkcję flp_location_callback za każdym razem, gdy zostanie ustalona lokalizacja. Zastępuje to ustawienie flagi FLP_BATCH_WAKEUP_ON_FIFO_FULL. Wyłączenie go jest obowiązkiem wyższych warstw (rozmówcy), jeśli wie, że punkt dostępowy może przejść w stan uśpienia. Jest to przydatne w zastosowaniach nawigacyjnych, gdy system pracuje w trybie dużej mocy. Parametry: id - Identyfikator żądania. opcje — zobacz definicję struktury FlpBatchOptions . Wartość zwracana: FLP_RESULT_SUCCESS w przypadku powodzenia, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR w przypadku niepowodzenia.

Definicja w linii 367 plikufused_location.h .

int(* stop_batching)(int id)

Zatrzymaj dozowanie. Parametry: id - Identyfikator żądania. Wartość zwracana: FLP_RESULT_SUCCESS w przypadku powodzenia, FLP_RESULT_ID_UNKNOWN lub FLP_RESULT_ERROR w przypadku niepowodzenia.

Definicja w linii 392 plikufused_location.h .

int(* update_batching_options)(int id, FlpBatchOptions *new_options)

Zaktualizuj FlpBatchOptions powiązany z żądaniem przetwarzania wsadowego. Gdy trwa operacja przetwarzania wsadowego i należy zaktualizować opcję przetwarzania wsadowego, taką jak FLP_BATCH_WAKEUP_ON_FIFO_FULL, zostanie użyty ten interfejs API. Może się to na przykład zdarzyć, gdy punkt dostępowy jest wybudzony i używana jest aplikacja z mapami. Parametry: id - Identyfikator istniejącego żądania wsadowego. new_options - Zaktualizowano FlpBatchOptions Wartość zwracana: FLP_RESULT_SUCCESS w przypadku powodzenia, FLP_RESULT_ID_UNKNOWN, FLP_RESULT_ERROR w przypadku błędu.

Definicja w linii 382 plikufused_location.h .

Dokumentacja tej struktury została wygenerowana z następującego pliku: