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 üyelerini içerir.

Özet

Bu nesneler, BdxProtocol tarafından protokol durumunu korumak için kullanılır. Bunlar, Connections and ExchangeContexts yönetimi de dahil olmak üzere yeni aktarımlar oluşturma ve başlatma işlemlerini yapan BdxServer tarafından yönetilir.

Herkese açık özellikler

mAmInitiator
bool
mAmSender
bool
mAppState
void *
mBlockCounter
uint32_t
Gönderim sırasında (aktarım resmi olarak başladıktan sonra) BlockQuery veya BlockACK almasını beklediğimiz bir sonraki blok numarası.
mBytesSent
uint64_t
mExchangeContext
mFileDesignator
dosya/engelleme ilgili veri üyelerinin YAPILACAKLAR: Bu kaldırılsın mı? Yoksa bu dizenin nasıl görüneceğine ve nasıl kullanılacağına dair bir sözleşme hazırlamamız mı gerekiyor? Özellikle, bir PacketBuffer tarafından destekleniyor mu? Öyleyse muhtemelen tüm xfer'de kalmamalıdır çünkü bu bir pbuf kaplar
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

Herkese açık işlevler

DispatchErrorHandler(WEAVE_ERROR anErrorCode)
void
Hata işleyici ayarlanmışsa çağırın.
DispatchGetBlockHandler(uint64_t *aLength, uint8_t **aDataBlock, bool *aLastBlock)
void
Get blok işleyici ayarlanmışsa çağırın.
DispatchPutBlockHandler(uint64_t aLength, uint8_t *aDataBlock, bool aLastBlock)
void
Yerleştirme bloku işleyicisi ayarlanmışsa bu işleyiciyi çağırın.
DispatchReceiveAccept(ReceiveAccept *aReceiveAcceptMsg)
Sevk görevlileri bir işleyicinin ayarlanıp ayarlanmadığını kontrol eder ve varsa onu arar.
DispatchRejectHandler(StatusReport *aReport)
void
Ret işleyici ayarlanmışsa çağırın.
DispatchSendAccept(SendAccept *aSendAcceptMsg)
Gönderme kabul işleyicisi ayarlanmışsa çağırın.
DispatchXferDoneHandler(void)
void
Aktarım tamamlandı işleyicisi ayarlanmışsa arayın.
DispatchXferErrorHandler(StatusReport *aXferError)
void
Aktarım hatası işleyici ayarlanmışsa çağırın.
GetDefaultFlags(bool aExpectResponse)
uint16_t
Bu işlev, mesajla birlikte 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

Gönderim sırasında (aktarım resmi olarak başladıktan sonra) BlockQuery veya BlockACK almasını beklediğimiz bir sonraki blok numarası.

Bu, almayı beklediğimiz bir sonraki BlockSend veya BlockQuery'dir (aktarım resmi olarak başladıktan ve gönderilen ilk sorgu bu tarihten 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

dosya/engelleme ilgili veri üyelerinin YAPILACAKLAR: Bu kaldırılsın mı? Yoksa bu dizenin nasıl görüneceğine ve nasıl kullanılacağına dair bir sözleşme hazırlamamız mı gerekiyor? Özellikle, bir PacketBuffer tarafından destekleniyor mu? Öyleyse muhtemelen tüm xfer'de kalmamalıdır çünkü bu bir pbuf kaplar

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

Herkese açık işlevler

DispatchErrorHandler

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

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

Ayarlanmazsa aktarımı varsayılan davranış olarak 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
)

Get blok işleyici ayarlanmışsa ç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 blok ise doğru değerini alır

DispatchPutBlockHandler

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

Yerleştirme bloku işleyicisi ayarlanmışsa bu işleyiciyi ç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 blok ise 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 onu arar.

Alma kabul işleyicisi ayarlanmışsa çağırın.

Bu nedenle bunlar, geri çağırmaları yapmak için herkese açık arayüz olarak kullanılmalıdır ve dış uygulamalar tarafından hiçbir zaman doğrudan ele alınmamalıdır. BDXTransfer'in gelecekteki bir düzeltmesinde, geri çağırmaların her biri için bağımsız işaretçiler depolamak yerine, yetki verilmiş bir nesne kullanılması mümkündür.

Ayrıntılar
Parametreler
[in] aReceiveAcceptMsg
ReceiveAccept mesajı işlenecek
İadeler
hata değeri

DispatchRejectHandler

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

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

Ayarlanmazsa aktarımı varsayılan davranış olarak kapatın.

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

DispatchSendAccept

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

Gönderme kabul işleyicisi ayarlanmışsa çağırın.

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

DispatchXferDoneHandler

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

Aktarım tamamlandı işleyicisi ayarlanmışsa arayın.

Ayarlanmazsa aktarımı varsayılan davranış olarak kapatın.

DispatchXferErrorHandler

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

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

Ayarlanmazsa aktarımı varsayılan davranış olarak 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 birlikte gönderilecek varsayılan işaretleri döndürür.

Ayrıntılar
Parametreler
[in] aExpectResponse
Bu iletiye yanıt verilmesini beklersek
İ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 true.

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 varlık bu aktarımın sürücüsüyse true

Sıfırla

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

 Sets all pointers to NULL, resets counters, etc.

Kapatıldığında çağrılır.

SetHandlers

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

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

İşleyici işlevi işaretçilerinin temel uygulama yöntemi, herkese açık API'nin bir parçası olmadığından, bunları manuel olarak ayarlamaya çalışmak yerine her zaman bu yöntemi kullanmalısınız.

Ayrıntılar
Parametreler
[in] aHandlers
Çağrılacak geri arama 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ırsatı, aktarımla ilişkili tüm kaynakları ve uygulama mantığınızı serbest bırakmak için kullanın.