Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

nl::Weave::Profile::BDX_Entwicklung::SendInit

#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>

Mit der Nachricht SendInit wird eine Anzeigenplattform gestartet, wenn der Absender initiiert wird.

Fazit

Übernahme

Direkte bekannte Unterklassen: nl::Weave::Profiles::BDX_Entwicklungment::ReceiveInit

Konstrukteur und Zerstörer

SendInit(void)

Öffentliche Typen

MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) Typdef
Mit MetaDataTLVWriteCallback kann ein Client ein SendInit mit beliebigen Metadaten bereitstellen.

Öffentliche Attribute

mAsynchronousModeSupported
bool
True, wenn der asynchrone Modus unterstützt wird.
mDefiniteLength
bool
True, wenn das Feld für die Länge vorhanden ist.
mFileDesignator
String mit vorab ausgehandelten Informationen.
mLength
uint64_t
Vorgeschlagene Länge der übertragenen Daten, 0 für unbegrenzt.
mMaxBlockSize
uint16_t
Vorgeschlagene maximale Blockgröße, die bei der Übertragung verwendet werden soll.
mMetaData
Optionale TLV-Metadaten
mMetaDataAppState
void *
Optionaler App-Status für TLV-Metadaten
mMetaDataWriteCallback
Optionale Funktion zum Ausgeben von TLV-Metadaten.
mReceiverDriveSupported
bool
True, wenn wir das Empfängerlaufwerk unterstützen.
mSenderDriveSupported
bool
Dieser Wert ist „true“, wenn wir Drive-Dateien des Absenders unterstützen können.
mStartOffset
uint64_t
Vorgeschlagener Start-Offset von Daten.
mStartOffsetPresent
bool
„True“, wenn das Feld für den Startversatz vorhanden ist.
mVersion
uint8_t
Die Version des BDX-Protokolls, die wir beschlossen haben.
mWideRange
bool
„True“, wenn Offset und Länge 64 Bit betragen.

Öffentliche Funktionen

init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
Initialisierung von wideInit
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
„&nont;non-widet;“ senden
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
Initialisierung von wideInit
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
„&nont;non-widet;“ senden
operator==(const SendInit &) const
bool
Gleichheitsvergleich zwischen SendInit-Nachrichten
pack(PacketBuffer *aBuffer)
Verpacken Sie eine Init-Nachricht in einen PacketBuffer.
packedLength(void)
uint16_t
Gibt die Paketlänge dieser Initiierungsnachricht zurück.

Öffentliche statische Funktionen

parse(PacketBuffer *aBuffer, SendInit & aRequest)
Parsen Sie Daten aus einem PacketBuffer in ein SendInit-Nachrichtenformat.

Öffentliche Typen

MetaDataTLVWriteCallback

WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)

Mit MetaDataTLVWriteCallback kann ein Client ein SendInit mit beliebigen Metadaten bereitstellen.

Der Client kann kostenlos TLV (schneller) bereitstellen, spontan codieren (weniger Arbeitsspeicher verwenden), Lazy-Codierung (bei Start littl schneller) usw.

In allen Fällen wird angenommen, dass die vom Callback erzeugten Daten für ein bestimmtes SendInit konstant sind, d.h. sich unabhängig vom Aufruf nicht ändert. Das liegt daran, dass der Callback auch zur Berechnung der Länge eines solchen ausgeschriebenen TLV verwendet wird, der jederzeit angefordert werden kann.

Details
Parameter
[in] aBuffer
Der Zielzwischenspeicher, in den einige TLV geschrieben werden kann
[in] aBufferLength
Die Länge (in Byte) des Zielzwischenspeichers
[in,out] aNumBytesWritten
Die Anzahl der Byte, die in den Zielzwischenspeicher geschrieben wurden
[in] aAppState
Vom Nutzer bereitgestellter App-Status
Rückgabewerte
WEAVE_ERROR
Es ist ein Fehler aufgetreten.

Öffentliche Attribute

mAsyncModeSupported

bool mAsynchronousModeSupported

True, wenn der asynchrone Modus unterstützt wird.

mDefiniteLänge

bool mDefiniteLength

True, wenn das Feld für die Länge vorhanden ist.

mFileDesignator

ReferencedString mFileDesignator

String mit vorab ausgehandelten Informationen.

mLänge

uint64_t mLength

Vorgeschlagene Länge der übertragenen Daten, 0 für unbegrenzt.

mMaxBlockSize

uint16_t mMaxBlockSize

Vorgeschlagene maximale Blockgröße, die bei der Übertragung verwendet werden soll.

mMetaData

ReferencedTLVData mMetaData

Optionale TLV-Metadaten

mMetaDataAppState

void * mMetaDataAppState

Optionaler App-Status für TLV-Metadaten

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

Optionale Funktion zum Ausgeben von TLV-Metadaten.

mReceiverDriveUnterstützt

bool mReceiverDriveSupported

True, wenn wir das Empfängerlaufwerk unterstützen.

mSenderDriveUnterstützt

bool mSenderDriveSupported

Dieser Wert ist „true“, wenn wir Drive-Dateien des Absenders unterstützen können.

mStart

uint64_t mStartOffset

Vorgeschlagener Start-Offset von Daten.

mStartOffsetpresent

bool mStartOffsetPresent

„True“, wenn das Feld für den Startversatz vorhanden ist.

MVersion

uint8_t mVersion

Die Version des BDX-Protokolls, die wir beschlossen haben.

mWideRange

bool mWideRange

„True“, wenn Offset und Länge 64 Bit betragen.

Öffentliche Funktionen

Gesendet

 SendInit(
  void
)

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint64_t aStartOffset,
  uint64_t aLength,
  ReferencedString & aFileDesignator,
  ReferencedTLVData *aMetaData
)

Initialisierung von wideInit

Details
Parameter
[in] aVersion
BDX-Version, die wir verwenden
[in] aSenderDrive
True, wenn der Absender
[in] aReceiverDrive
True, wenn der Empfänger fährt
[in] aAsynchMode
True, wenn das Gerät den asynchronen Modus unterstützt
[in] aMaxBlockSize
Vorschlag für eine maximale Blockgröße für diese Übertragung
[in] aStartOffset
Startversatz in der Datei, mit der wir beginnen möchten
[in] aLength
Länge der zu übertragenden Datei: 0 bedeutet, dass die Datei unbegrenzt ist.
[in] aFileDesignator
Ein String, der die zu übertragenden Daten identifiziert
[in] aMetaData
Optional: Zusätzliche Daten im TLV-Format
Rückgabe
WEAVE_NO_ERROR, wenn der Vorgang erfolgreich ist

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint32_t aStartOffset,
  uint32_t aLength,
  ReferencedString & aFileDesignator,
  ReferencedTLVData *aMetaData
)

„&nont;non-widet;“ senden

Details
Parameter
[in] aVersion
BDX-Version, die wir verwenden
[in] aSenderDrive
True, wenn der Absender
[in] aReceiverDrive
True, wenn der Empfänger fährt
[in] aAsynchMode
True, wenn das Gerät den asynchronen Modus unterstützt
[in] aMaxBlockSize
Vorschlag für eine maximale Blockgröße für diese Übertragung
[in] aStartOffset
Startversatz in der Datei, mit der wir beginnen möchten
[in] aLength
Länge der zu übertragenden Datei: 0 bedeutet, dass die Datei unbegrenzt ist.
[in] aFileDesignator
Ein String, der die zu übertragenden Daten identifiziert
[in] aMetaData
Optional: Zusätzliche Daten im TLV-Format
Rückgabe
WEAVE_NO_ERROR, wenn der Vorgang erfolgreich ist

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint64_t aStartOffset,
  uint64_t aLength,
  ReferencedString & aFileDesignator,
  MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

Initialisierung von wideInit

Details
Parameter
[in] aVersion
BDX-Version, die wir verwenden
[in] aSenderDrive
True, wenn der Absender
[in] aReceiverDrive
True, wenn der Empfänger fährt
[in] aAsynchMode
True, wenn das Gerät den asynchronen Modus unterstützt
[in] aMaxBlockSize
Vorschlag für eine maximale Blockgröße für diese Übertragung
[in] aStartOffset
Startversatz in der Datei, mit der wir beginnen möchten
[in] aLength
Länge der zu übertragenden Datei: 0 bedeutet, dass die Datei unbegrenzt ist.
[in] aFileDesignator
Ein String, der die zu übertragenden Daten identifiziert
[in] aMetaDataWriteCallback
Optional: Eine Funktion zum Ausgeben zusätzlicher Daten im TLV-Format
[in] aMetaDataAppState
Ein optionaler Kontext, der an aMetaDataWriteCallback übergeben wird
Rückgabe
WEAVE_NO_ERROR, wenn der Vorgang erfolgreich ist

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint32_t aStartOffset,
  uint32_t aLength,
  ReferencedString & aFileDesignator,
  MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

„&nont;non-widet;“ senden

Details
Parameter
[in] aVersion
BDX-Version, die wir verwenden
[in] aSenderDrive
True, wenn der Absender
[in] aReceiverDrive
True, wenn der Empfänger fährt
[in] aAsynchMode
True, wenn das Gerät den asynchronen Modus unterstützt
[in] aMaxBlockSize
Vorschlag für eine maximale Blockgröße für diese Übertragung
[in] aStartOffset
Startversatz in der Datei, mit der wir beginnen möchten
[in] aLength
Länge der zu übertragenden Datei: 0 bedeutet, dass die Datei unbegrenzt ist.
[in] aFileDesignator
Ein String, der die zu übertragenden Daten identifiziert
[in] aMetaDataWriteCallback
Optional: Eine Funktion zum Ausgeben zusätzlicher Daten im TLV-Format
[in] aMetaDataAppState
Optional: Ein Kontext, der an die Callback-Funktion zurückgegeben werden soll
Rückgabe
WEAVE_NO_ERROR, wenn der Vorgang erfolgreich ist

Operator==

bool operator==(
  const SendInit &
) const 

Gleichheitsvergleich zwischen SendInit-Nachrichten

Details
Parameter
[in] another
Eine weitere SendInit-Nachricht zum Vergleich dieser
Rückgabe
„true“, wenn sie dieselben Felder haben.

Packung

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Verpacken Sie eine Init-Nachricht in einen PacketBuffer.

Details
Parameter
[out] aBuffer
Ein PacketBuffer für die Verpackung der SendInit-Nachricht
Rückgabewerte
WEAVE_NO_ERROR
Wenn der Vorgang erfolgreich war
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn der Puffer zu klein ist

Lackte Länge

uint16_t packedLength(
  void
)

Gibt die Paketlänge dieser Initiierungsnachricht zurück.

Details
Rückgabe
Länge der Nachricht im Paket

Öffentliche statische Funktionen

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

Parsen Sie Daten aus einem PacketBuffer in ein SendInit-Nachrichtenformat.

Details
Parameter
[in] aBuffer
Mauszeiger auf einen PacketBuffer mit den Daten, die wir parsen möchten
[out] aRequest
Mauszeiger auf ein SendInit-Objekt bewegen, in dem die Ergebnisse gespeichert werden sollen
Rückgabewerte
WEAVE_NO_ERROR
Wenn der Vorgang erfolgreich war
WEAVE_ERROR_BUFFER_TOO_SMALL
Wenn der Puffer zu klein ist