nl::Weave::Profiller:BDX_Geliştirme:BDXTransfer

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

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

Özet

Bu nesneler, protokol durumunu korumak için BdxProtocol tarafından kullanılır. Bunlar, Bağlantıları ve ExchangeBağlamlarını yönetme dahil olmak üzere yeni aktarım oluşturma ve başlatma işlemini gerçekleştiren BdxServer tarafından yönetilir.

Herkese açık özellikler

mAmInitiator
bool
mAmSender
bool
mAppState
void *
mBlockCounter
uint32_t
Gönderim sırasında BlockQuery veya BlockACK almayı beklediğimiz bir sonraki blok numarası (aktarım resmi olarak başladıktan sonra).
mBytesSent
uint64_t
mExchangeContext
mFileDesignator
dosya/engelleme konusunda ilgili üyeleri YAPMAYIN: Bunu kaldırın mı? Yoksa bu dizenin nasıl görüneceğine ve nasıl kullanılacağına dair bir sözleşme imzalamalı mıyız? Özellikle, bir PacketBuffer tarafından destekleniyor mu? Öyleyse büyük olasılıkla pbuf kapladığı için Xxfer'in tamamına bağlı kalmalıdır
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 ayarlandıysa bunu çağırın.
DispatchGetBlockHandler(uint64_t *aLength, uint8_t **aDataBlock, bool *aLastBlock)
void
Alma bloku işleyicisi ayarlanmışsa bunu çağırın.
DispatchPutBlockHandler(uint64_t aLength, uint8_t *aDataBlock, bool aLastBlock)
void
Ayar bloku işleyicisi ayarlanmışsa bunu çağırın.
DispatchReceiveAccept(ReceiveAccept *aReceiveAcceptMsg)
Görev dağıtıcılar bir işleyicinin ayarlanıp ayarlanmadığını kontrol edip arayabilirler.
DispatchRejectHandler(StatusReport *aReport)
void
Ret işleyici ayarlanmışsa bunu çağırın.
DispatchSendAccept(SendAccept *aSendAcceptMsg)
Gönderme kabul işleyici ayarlanmışsa bu işleyiciyi arayın.
DispatchXferDoneHandler(void)
void
Aktarım işleyici ayarlanmışsa bunu ayarlayın.
DispatchXferErrorHandler(StatusReport *aXferError)
void
Aktarım hatası işleyici ayarlandıysa bunu ç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

Mobil Girişimci

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

mAmGönderen

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

mobil uygulama durumu

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

mBlockCounter

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

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

Alma sırasında, göndermeyi beklediğimiz bir sonraki BlockSend veya BlockQuery (aktarım resmi olarak başladıktan ve gönderilen ilk sorgu tamamlandıktan sonra) bu numarayı alır.

Gönderilen mBytes

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 konusunda ilgili üyeleri YAPMAYIN: Bunu kaldırın mı? Yoksa bu dizenin nasıl görüneceğine ve nasıl kullanılacağına dair bir sözleşme imzalamalı mıyız? Özellikle, bir PacketBuffer tarafından destekleniyor mu? Öyleyse büyük olasılıkla pbuf kapladığı için Xxfer'in tamamına bağlı kalmalıdır

İlk Sorgu

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

mHandler'lar

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

Kabul Edilen

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

Tüm Alışverişler Tamamlandı

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

Başla

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

mIsWideRange

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

mUzunluk

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

mMaxBlockSize

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

mSonraki

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

mStartOfset

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 (Açık)

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

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

Ayarlanmazsa aktarımı varsayılan davranış olarak devre dışı bırakın.

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

DispatchGetBlockHandler (Tek Nokta)

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

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

Ayrıntılar
Parametreler
[in] aLength
Blok uzunluğu
[in] aDataBlock
Veri bloğunun üzerine gelme
[in] aLastBlock
Bu, aktarımdaki son bloksa doğrudur

DispatchPutBlockHandler ise

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

Ayar bloku işleyicisi ayarlanmışsa bunu çağırın.

Ayrıntılar
Parametreler
[in] aLength
Blok uzunluğu
[in] aDataBlock
Veri bloğunun üzerine gelme
[in] aLastBlock
Bu, aktarımdaki son bloksa doğrudur

DispatchReceiveAccept

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

Görev dağıtıcılar bir işleyicinin ayarlanıp ayarlanmadığını kontrol edip arayabilirler.

Alma kabul işleyici ayarlandıysa onu çağırın.

Bu nedenle, bunlar geri çağırma işlemleri için herkese açık arayüz olarak kullanılmalıdır ve dış uygulamalar tarafından hiçbir zaman doğrudan dokunulmamalıdır. BDXTransfer hizmetinin gelecekteki bir düzeltmesi, geri çağırmaların her birine işaretçileri tek tek depolamak yerine yetki verilen bir nesne kullanabilir.

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

DispatchRejectedHandler değeri

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

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

Ayarlanmazsa aktarımı varsayılan davranış olarak devre dışı bırakı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şleyici ayarlanmışsa bu işleyiciyi arayın.

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

DispatchXferBittiHandler

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

Aktarım işleyici ayarlanmışsa bunu ayarlayın.

Ayarlanmazsa aktarımı varsayılan davranış olarak devre dışı bırakın.

DispatchXferErrorHandler (Açık)

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

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

Ayarlanmazsa aktarımı varsayılan davranış olarak devre dışı bırakın.

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

GetDefaultFlag'ler

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 mesaja yanıt verilmesini bekliyorsak
İadeler
Gönderilecek bayraklar

Eşzamanlı

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 (doğru) değerine ayarlanırsa.

Sürücü

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
true (doğru) değerine ayarlanırsa bu varlık, bu aktarım için itici güçtür

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.

Set Tutucuları

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, herkese açık API'nın bir parçası olmadığından, her zaman manuel olarak ayarlamayı denemek yerine bu yöntemi kullanmalısınız.

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