nl::Weave::Profiles::BDX_Development::BDXTransfer

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

Bu yapı, etkin bir BDX aktarımını temsil eden veri üyeleri içerir.

Özet

Bu nesneler, protokol durumunu korumak için BdxProtocol tarafından kullanılır. Bunlar, Bağlantıları ve ExchangeContext'leri yönetme de dahil olmak üzere yeni aktarımlar oluşturma ve başlatma işlemlerini yürüten BdxServer tarafından yönetilir.

Herkese açık özellikler

mAmInitiator
bool
mAmSender
bool
mAppState
void *
mBlockCounter
uint32_t
E-posta gönderirken (aktarım resmi olarak başladığında) BlockQuery veya BlockACK'yi almayı beklediğimiz sonraki blok numarası.
mBytesSent
uint64_t
mExchangeContext
mFileDesignator
ilgili verileri dosyala/engelle Yapılacaklar: bunu kaldırın mı? Yoksa sadece bu dizenin nasıl görünebileceğine ve nasıl kullanılacağına dair bir sözleşme mi oluşturmalıyız? Daha ayrıntılı olarak belirtmek gerekirse, PacketBuffer tarafından destekleniyor mu? Öyleyse, muhtemelen tüm ekstraları sarfmanız gerekir çünkü
mFirstQuery
bool
mHandlers
mIsAccepted
bool
mIsCompletedSuccessfully
bool
mIsInitiated
bool
mIsWideRange
bool
mLength
uint64_t
mMaxBlockSize
uint16_t
mNext)(BDXTransfer &)
mStartOffset
uint64_t
mTransferMode
uint8_t
mVersion
uint8_t

Kamu işlevleri

DispatchErrorHandler(WEAVE_ERROR anErrorCode)
void
Hata işleyici ayarlanmışsa çağırın.
DispatchGetBlockHandler(uint64_t *aLength, uint8_t **aDataBlock, bool *aLastBlock)
void
Al blok işleyici ayarlandıysa bunu çağırın.
DispatchPutBlockHandler(uint64_t aLength, uint8_t *aDataBlock, bool aLastBlock)
void
Puset engelleme işleyicisi ayarlandıysa bunu çağırın.
DispatchReceiveAccept(ReceiveAccept *aReceiveAcceptMsg)
Sevk görevlileri bir işleyicinin ayarlanıp ayarlanmadığını kontrol eder ve varsa işlevi arar.
DispatchRejectHandler(StatusReport *aReport)
void
Ret işleyicisi ayarlandıysa bunu çağırın.
DispatchSendAccept(SendAccept *aSendAcceptMsg)
Kabul gönderme işleyici ayarlandıysa bu işleyiciyi arayın.
DispatchXferDoneHandler(void)
void
Aktarım tamamlandı işleyici ayarlandıysa çağırın.
DispatchXferErrorHandler(StatusReport *aXferError)
void
Aktarım hatası işleyici ayarlanmışsa çağırın.
GetDefaultFlags(bool aExpectResponse)
uint16_t
Bu işlev, mesajla gönderilecek varsayılan işaretleri döndürür.
IsAsync(void)
bool
 Returns true if this transfer is asynchronous, false otherwise.
IsDriver(void)
bool
 Returns true if this entity (node) is the driver for this transfer, false otherwise.
Reset(void)
void
 Sets all pointers to NULL, resets counters, etc.
SetHandlers(BDXHandlers aHandlers)
void
Bu işlev, bu BDXTransfer nesnesindeki işleyicileri ayarlar.
Shutdown(void)
void
 Shuts down the current transfer, including closing any open ExchangeContext.

Herkese açık özellikler

mAmInitiator

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mAmInitiator

mAmSender

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mAmSender

mAppState

void * nl::Weave::Profiles::BDX_Development::BDXTransfer::mAppState

mBlockCounter

uint32_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mBlockCounter

E-posta gönderirken (aktarım resmi olarak başladığında) BlockQuery veya BlockACK'yi almayı beklediğimiz sonraki blok numarası.

Aldığımızda, almayı beklediğimiz bir sonraki BlockSend veya gönderdiğimiz en son BlockQuery budur (aktarım resmi olarak başladıktan ve gönderilen ilk sorgudan sonra).

mBytesSent

uint64_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mBytesSent

mExchangeContext

ExchangeContext * nl::Weave::Profiles::BDX_Development::BDXTransfer::mExchangeContext

mFileDesignator

ReferencedString nl::Weave::Profiles::BDX_Development::BDXTransfer::mFileDesignator

ilgili verileri dosyala/engelle Yapılacaklar: bunu kaldırın mı? Yoksa sadece bu dizenin nasıl görünebileceğine ve nasıl kullanılacağına dair bir sözleşme mi oluşturmalıyız? Daha ayrıntılı olarak belirtmek gerekirse, PacketBuffer tarafından destekleniyor mu? Öyleyse, muhtemelen tüm ekstraları sarfmanız gerekir çünkü

mFirstQuery

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mFirstQuery

mHandlers

BDXHandlers nl::Weave::Profiles::BDX_Development::BDXTransfer::mHandlers

mIsAccepted

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsAccepted

mIsCompletedSuccessfully

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsCompletedSuccessfully

mIsInitiated

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsInitiated

mIsWideRange

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsWideRange

mLength

uint64_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mLength

mMaxBlockSize

uint16_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mMaxBlockSize

mNext

WEAVE_ERROR(* nl::Weave::Profiles::BDX_Development::BDXTransfer::mNext)(BDXTransfer &)

mStartOffset

uint64_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mStartOffset

mTransferMode

uint8_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mTransferMode

mVersion

uint8_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mVersion

Kamu işlevleri

DispatchErrorHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchErrorHandler(
  WEAVE_ERROR anErrorCode
)

Hata işleyici ayarlanmışsa çağırın.

Politika ayarlanmadan bırakılırsa varsayılan davranış olarak aktarımı da kapatın.

Ayrıntılar
Parametreler
[in] anErrorCode
İşlenecek hata kodu

DispatchGetBlockHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchGetBlockHandler(
  uint64_t *aLength,
  uint8_t **aDataBlock,
  bool *aLastBlock
)

Al blok işleyici ayarlandıysa bunu çağırın.

Ayrıntılar
Parametreler
[in] aLength
Blok uzunluğu
[in] aDataBlock
Veri bloğunun işaretçisi
[in] aLastBlock
Bu, aktarımdaki son bloksa doğru değerini alır

DispatchPutBlockHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchPutBlockHandler(
  uint64_t aLength,
  uint8_t *aDataBlock,
  bool aLastBlock
)

Puset engelleme işleyicisi ayarlandıysa bunu çağırın.

Ayrıntılar
Parametreler
[in] aLength
Blok uzunluğu
[in] aDataBlock
Veri bloğunun işaretçisi
[in] aLastBlock
Bu, aktarımdaki son bloksa doğru değerini alır

DispatchReceiveAccept

WEAVE_ERROR nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchReceiveAccept(
  ReceiveAccept *aReceiveAcceptMsg
)

Sevk görevlileri bir işleyicinin ayarlanıp ayarlanmadığını kontrol eder ve varsa işlevi arar.

Alma kabul işleyicisi ayarlandıysa bunu arayın.

Bu nedenle, geri çağırmaları çağırmak için herkese açık arayüz olarak kullanılmalıdır ve bunların hiçbir zaman doğrudan dış uygulamalar tarafından kullanılmaması gerekir. BDXTransfer'in gelecekteki bir düzeltmesinin, geri çağırmaların her birine tek tek işaretçiler depolamak yerine bir temsilci nesne kullanması mümkün olabilir.

Ayrıntılar
Parametreler
[in] aReceiveAcceptMsg
ReceiveAccept mesajı işlenmek üzere
İadeler
bir hata değeri

DispatchRejectHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchRejectHandler(
  StatusReport *aReport
)

Ret işleyicisi ayarlandıysa bunu çağırın.

Politika ayarlanmadan bırakılırsa varsayılan davranış olarak aktarımı da kapatın.

Ayrıntılar
Parametreler
[in] aReport
İşlenecek StatusReport mesajı

DispatchSendAccept

WEAVE_ERROR nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchSendAccept(
  SendAccept *aSendAcceptMsg
)

Kabul gönderme işleyici ayarlandıysa bu işleyiciyi arayın.

Ayrıntılar
Parametreler
[in] aSendAcceptMsg
SendAccept mesajının işlenmesi
İadeler
bir hata değeri

DispatchXferDoneHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchXferDoneHandler(
  void
)

Aktarım tamamlandı işleyici ayarlandıysa çağırın.

Politika ayarlanmadan bırakılırsa varsayılan davranış olarak aktarımı da kapatın.

DispatchXferErrorHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchXferErrorHandler(
  StatusReport *aXferError
)

Aktarım hatası işleyici ayarlanmışsa çağırın.

Politika ayarlanmadan bırakılırsa varsayılan davranış olarak aktarımı da kapatın.

Ayrıntılar
Parametreler
[in] aXferError
İşlenecek bir hatanın durum raporu

GetDefaultFlags

uint16_t nl::Weave::Profiles::BDX_Development::BDXTransfer::GetDefaultFlags(
  bool aExpectResponse
)

Bu işlev, mesajla gönderilecek varsayılan işaretleri döndürür.

Ayrıntılar
Parametreler
[in] aExpectResponse
Bu iletiye bir yanıt almayı bekliyorsak
İadeler
Gönderilecek işaretler

IsAsync

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::IsAsync(
  void
)

 Returns true if this transfer is asynchronous, false otherwise.

Ayrıntılar
İadeler
Aktarım eşzamansızsa doğru olacaktır.

IsDriver

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::IsDriver(
  void
)

 Returns true if this entity (node) is the driver for this transfer, false otherwise.

Ayrıntılar
İadeler
Bu aktarımın nedeni bu varlıksa true

Sıfırla

void nl::Weave::Profiles::BDX_Development::BDXTransfer::Reset(
  void
)

 Sets all pointers to NULL, resets counters, etc.

Kapandığında aradı.

SetHandlers

void nl::Weave::Profiles::BDX_Development::BDXTransfer::SetHandlers(
  BDXHandlers aHandlers
)

Bu işlev, bu BDXTransfer nesnesindeki işleyicileri ayarlar.

İşleyici işlev işaretçilerinin depolanma şekli genel API'nin bir parçası olmadığı için bunları manuel olarak ayarlamaya çalışmak yerine her zaman bu yöntemi kullanmanız gerekir.

Ayrıntılar
Parametreler
[in] aHandlers
Çağrılacak geri çağırma işleyicilerin yapısı

Kapat

void nl::Weave::Profiles::BDX_Development::BDXTransfer::Shutdown(
  void
)

 Shuts down the current transfer, including closing any open ExchangeContext.

Bu fırsattan yararlanarak bu aktarımla ve uygulama mantığınızla ilişkili tüm kaynakları serbest bırakın.