nl:: Weave:: Profiles:: BDX_Development
Bu ad alanı, Toplu Veri Aktarımı (BDX) profili için Weave'de aktif olarak geliştirme aşamasında olan ve üretimde kullanılmaması gereken tüm arayüzleri içerir.
Özet
Sıralamalar |
|
---|---|
@80
|
enum |
@81
|
enum |
@82
|
enum |
@83
|
enum |
Türdefler |
|
---|---|
BdxClient
|
typedef |
BdxServer
|
typedef |
ErrorHandler)(BDXTransfer *aXfer, WEAVE_ERROR anErrorCode)
|
typedefvoid(*
Bu işleyici, hata kodları aracılığıyla kullanıcı tarafından uygulama tarafından tanımlanan kontrol akışına doğrudan döndürülmeyen bir Weave hatasıyla karşılaşıldığında çağrılır. |
GetBlockHandler)(BDXTransfer *aXfer, uint64_t *aLength, uint8_t **aDataBlock, bool *aLastBlock)
|
typedefvoid(*
Get a block of data to be transmitted. |
PutBlockHandler)(BDXTransfer *aXfer, uint64_t aLength, uint8_t *aDataBlock, bool aLastBlock)
|
typedefvoid(*
aLength değerine sahip birDataBlock tarafından işaret edilen veri bloğunu işleyin. |
ReceiveAcceptHandler)(BDXTransfer *aXfer, ReceiveAccept *aReceiveAcceptMsg)
|
typedef Daha önce gönderilmiş bir ReceiveInit hedef tarafından kabul edildiğinde geri çağırma çağrılır. |
ReceiveInitHandler)(BDXTransfer *aXfer, ReceiveInit *aReceiveInitMsg)
|
typedefuint16_t(*
Bir ReceiveInit mesajı alındığında geri çağırma çağrıldı. |
RejectHandler)(BDXTransfer *aXfer, StatusReport *aReport)
|
typedefvoid(*
Önceki Init mesajlarından biri hedef tarafından reddedilirse çağrılır. |
SendAcceptHandler)(BDXTransfer *aXfer, SendAccept *aSendAcceptMsg)
|
typedef Daha önce gönderilmiş bir SendInit hedef tarafından kabul edildiğinde geri çağırma çağrılır. |
SendInitHandler)(BDXTransfer *aXfer, SendInit *aSendInitMsg)
|
typedefuint16_t(*
Bir SendInit mesajı alındığında geri çağırma çağrıldı. |
XferDoneHandler)(BDXTransfer *aXfer)
|
typedefvoid(*
Aktarımın tamamlandığı durumları ele alın. |
XferErrorHandler)(BDXTransfer *aXfer, StatusReport *aXferError)
|
typedefvoid(*
BDX tarafından alınan veya gönderilen TransferError iletilerini işleyin. |
İşlevler |
|
---|---|
GetBDXAckFlag(ExchangeContext *anEc)
|
uint16_t
GetBDXAckFlag, exchange bağlamının bağlantısına (TCP için istek ack'i yok) ve WRMP için derleme süresi desteğine göre requestAck alanı için uygun işareti döndürür.
|
Sınıflar |
|
---|---|
nl:: |
|
nl:: |
BlockAck mesajı bir veri blokunu onaylamak için kullanılır. |
nl:: |
BlockAckV1 mesajı bir veri blokunu onaylamak için kullanılır. |
nl:: |
BlockEOF mesajı, son veri bloğunu gönderenden alıcıya aktarmak için kullanılır. |
nl:: |
BlockEOFAck mesajı son veri bloğunu onaylamak için kullanılır. |
nl:: |
BlockEOFAckV1 mesajı son veri bloğunu onaylamak için kullanılır. |
nl:: |
BlockEOFV1 mesajı, son veri bloğunu gönderenden alıcıya aktarmak için kullanılır. |
nl:: |
BlockQuery mesajı, bir veri blokunun gönderenden alıcıya aktarılmasını istemek için kullanılır. |
nl:: |
BlockQueryV1 mesajı, bir veri blokunun gönderenden alıcıya aktarılmasını istemek için kullanılır. |
nl:: |
BlockSend mesajı, bir veri bloğunu gönderenden alıcıya aktarmak için kullanılır. |
nl:: |
BlockSendV1 mesajı, bir veri bloğunu gönderenden alıcıya aktarmak için kullanılır. |
nl:: |
Alıcı, başlatıcı olduğunda önerilen değişimi kabul etmek için ReceiveAccept mesajı kullanılır. |
nl:: |
Alıcı, başlatan olduğunda değişimi başlatmak için ReceiveInit mesajı kullanılır. |
nl:: |
ReceiveReject mesajı, gönderen kişi olduğunda önerilen değişimi reddetmek için kullanılır. |
nl:: |
SendAccept mesajı, gönderen kişi olduğunda önerilen değişimi kabul etmek için kullanılır. |
nl:: |
Gönderen kişi olduğunda exchange'i başlatmak için SendInit mesajı kullanılır. |
nl:: |
SendReject mesajı, gönderen kişi olduğunda önerilen alışverişi reddetmek için kullanılır. |
nl:: |
Hata mesajı, hata bildirmek ve bir değişimi iptal etmek için kullanılır. |
Yapılar |
|
---|---|
nl:: |
|
nl:: |
Bu yapı, etkin bir BDX aktarımını temsil eden veri üyeleri içerir. |
Ad alanları |
|
---|---|
nl:: |
Sıralamalar
@80
@80
@81
@81
@82
@82
@83
@83
Türdefler
BdxClient
BdxNode BdxClient
BdxServer
BdxNode BdxServer
ErrorHandler
void(* ErrorHandler)(BDXTransfer *aXfer, WEAVE_ERROR anErrorCode)
Bu işleyici, hata kodları aracılığıyla kullanıcı tarafından uygulama tarafından tanımlanan kontrol akışına doğrudan döndürülmeyen bir Weave hatasıyla karşılaşıldığında çağrılır.
Yani imzası "geçersiz" dönüş türüne sahip başka bir işleyicide bir hata oluşursa (ör. gelen bir Weave iletisine yanıt olarak veya protokol tarafından gönderilir) bu işleyici, kullanıcının aktarımın kurtarılıp devam edilip edilmeyeceğini veya Shutdown() işlevini çağırması gerekip gerekmediğini belirlemesi için bu işleyici çağrılır. Ayrılmış BDXTransfer çok sayıda aktarım nesnesi başlatılmadan önce bir hata meydana gelebilir (ör. Böyle bir durumda, söz konusu hata Weave tarafından günlüğe kaydedilir ve protokol, ayırdığı gerekli durumların temizlenmesi işlemini gerçekleştirir.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
GetBlockHandler
void(* GetBlockHandler)(BDXTransfer *aXfer, uint64_t *aLength, uint8_t **aDataBlock, bool *aLastBlock)
Get a block of data to be transmitted.
Arayan, arabelleğe alma alanını (referans yoluyla iletilen tampon ve tampon uzunluğu) sağlar. Arayanın (kullanıcı uygulaması) sağlanan arabelleği kullanması GEREKİR, ancak geriye dönük uyumluluk nedeniyle kendi arabelleğini döndürebilir. Arayan kişi, baytların aLength
kadarından fazlasını sağlamamalıdır. Dönüşte aLength
, arabelleğe okunan gerçek bayt sayısını içerir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
PutBlockHandler
void(* PutBlockHandler)(BDXTransfer *aXfer, uint64_t aLength, uint8_t *aDataBlock, bool aLastBlock)
aLength değerine sahip birDataBlock tarafından işaret edilen veri bloğunu işleyin.
Bu durum büyük olasılıkla, dosyanın bir dosyaya yazılmasını ve isLastBlock Doğru değerine ayarlanırsa söz konusu dosyanın kapatılmasını içerir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
ReceiveAcceptHandler
WEAVE_ERROR(* ReceiveAcceptHandler)(BDXTransfer *aXfer, ReceiveAccept *aReceiveAcceptMsg)
Daha önce gönderilmiş bir ReceiveInit hedef tarafından kabul edildiğinde geri çağırma çağrılır.
Bu fırsatı, aktarım işlemini başlatırken yapmadıysanız dosyaları açmak veya aktarım için kaynak tahsis etmek isteyebilirsiniz.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
ReceiveInitHandler
uint16_t(* ReceiveInitHandler)(BDXTransfer *aXfer, ReceiveInit *aReceiveInitMsg)
Bir ReceiveInit mesajı alındığında geri çağırma çağrıldı.
Görevi, Receive (Al) maddesini kabul etmek isteyip istemediğinizi belirlemek ve kabul etmekse protokolün başlatan kişiye bir kabul mesajı göndermesi için aXfer->mIsaccept=true değerini ayarlamaktır. BDXTransfer nesnesi, varsayılan ayarlarla başlatılır. Burası, uygulamaya özel durumları (açık dosya tanıtıcıları vb.) aXfer->mAppState'e eklemek için iyi bir yerdir. Bu noktada, blok işleme gibi gerekli işleyicileri BDXTransfer nesnesine eklemeniz gerekir. kStatus_Success dışında bir hata kodu döndürülürse aktarımın reddedildiği varsayılır ve protokol, kodla bir ret iletisi gönderme işlemini gerçekleştirir.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
RejectHandler
void(* RejectHandler)(BDXTransfer *aXfer, StatusReport *aReport)
Önceki Init mesajlarından biri hedef tarafından reddedilirse çağrılır.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
SendAcceptHandler
WEAVE_ERROR(* SendAcceptHandler)(BDXTransfer *aXfer, SendAccept *aSendAcceptMsg)
Daha önce gönderilmiş bir SendInit hedef tarafından kabul edildiğinde geri çağırma çağrılır.
Bu fırsatı, aktarım işlemini başlatırken yapmadıysanız dosyaları açmak veya aktarım için kaynak tahsis etmek isteyebilirsiniz.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
SendInitHandler
uint16_t(* SendInitHandler)(BDXTransfer *aXfer, SendInit *aSendInitMsg)
Bir SendInit mesajı alındığında geri çağırma çağrıldı.
Görevi, SendInit öğesini kabul etmek isteyip istemediğinizi belirlemektir. Kabul ediyorsanız protokolün, kabul edene bir kabul mesajı göndermesi için aXfer->mIsaccept=true değerini ayarlayın. BDXTransfer nesnesi, varsayılan ayarlarla başlatılır. Burası, uygulamaya özel durumları (açık dosya tanıtıcıları vb.) aXfer->mAppState'e eklemek için iyi bir yerdir. Bu noktada, blok işleme gibi gerekli işleyicileri BDXTransfer nesnesine eklemeniz gerekir. WEAVE_NO_ERROR dışında bir hata kodu döndürülürse aktarımın reddedildiği varsayılır ve protokol bu kodla bir ret iletisi gönderme işlemini gerçekleştirir.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
XferDoneHandler
void(* XferDoneHandler)(BDXTransfer *aXfer)
Aktarımın tamamlandığı durumları ele alın.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
XferErrorHandler
void(* XferErrorHandler)(BDXTransfer *aXfer, StatusReport *aXferError)
BDX tarafından alınan veya gönderilen TransferError iletilerini işleyin.
Not: BDX aktarımının potansiyel olarak kurtarılabilir olduğu (muhtemelen şu anda PacketBuffers'ın dışında) varsayılır. Bu nedenle, Shutdown() çağrısı yapma seçeneği uygulama programcısına ve tanımladığı geri çağırmalara bırakılır. YAPILACAKLAR: Bunu doğrulayın ve BDX dokümanındaki dille mutabık kılın. "[A TransferError] Taraflardan herhangi biri toplu veri aktarımını zamanından önce bitirmek için herhangi bir zamanda gönderilebilir."
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
İşlevler
GetBDXAckFlag
uint16_t GetBDXAckFlag( ExchangeContext *anEc )
GetBDXAckFlag, exchange bağlamının bağlantısına (TCP için istek ack'i yok) ve WRMP için derleme süresi desteğine göre requestAck alanı için uygun işareti döndürür.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
||
İadeler |
0 veya kSendFlag_RequestAck
|