finished packet: Data

src/main/java/packet/Data.java

@@ -0,0 +1,243 @@
+package packet;
+
+import component.*;
+import encoding.*;
+
+/*
+ * @Author: Wang Feng
+ * @Description:
+ * @Version: 1.0.0
+ * @Date: 10:25 2021/3/16
+ * @Copyright: MIN-Group；国家重大科技基础设施——未来网络北大实验室；深圳市信息论与未来网络重点实验室
+ */
+//
+// 表示一个MIN拉取式数据包
+//
+// @Description:
+// 	1. 包格式的定义如下
+//		Data = 7 TLV-LENGTH
+//             { DataIdentifier }            => 标识区
+//             { Signature }                 => 签名区
+//             {                             => 只读区
+//                 [FreshnessPeriod]
+//				   [NackHeader]
+//                 <Payload>
+//             }
+//             {                             => 可变区
+//                 {                         => 受保护区
+//                     [CongestionMark]
+//                 }
+//                 {                         => 非受保护区
+//                     "Empty"
+//                 }
+//             }
+//
+public class Data implements IEncodingAble,InteractWithField {
+    private MINPacket minPacket;
+    private FreshnessPeriod freshnessPeriod;
+    private Payload payload;
+    private CongestionMark congestionMark;
+    private NackHeader nackHeader;
+    private Identifier name;
+
+    /**
+     * 展示数据包的 URI
+     * @return
+     */
+    public String toUri(){
+        if(this.name==null){
+            return "";
+        }
+        return this.name.toUri();
+    }
+
+    /**
+     * 获取内容数据包的名字
+     * @return
+     */
+    public Identifier getName(){
+        return this.name;
+    }
+
+    public void setName(Identifier name) {
+        this.name = name;
+    }
+
+    /**
+     * 将 Data 的各项属性填充到 MINPacket 中定义的对应分区当中
+     * @return
+     */
+    @Override
+    public boolean fillDataToFields() {
+        /////////////////////////////////////////////////////////////
+        //// 填充可变区
+        //             {                             => 可变区
+        //                 {                         => 受保护区
+        //                     [CongestionMark]
+        //                 }
+        //                 {                         => 非受保护区
+        //                     "Empty"
+        //                 }
+        //             }
+        /////////////////////////////////////////////////////////////\
+        // 填充可变受保护区
+        this.minPacket.mutableField.mutableProtectField.clearBlocks();
+
+        // CongestionMark
+        Block block=new SelfEncodingBase().selfWireEncode(this.congestionMark);
+        if(block==null){
+            return false;
+        }
+        this.minPacket.mutableField.mutableProtectField.addBlock(block);
+
+        // 填充可变非受保护区（无）
+
+        /////////////////////////////////////////////////////////////
+        //// 填充只读区
+        //             {                             => 只读区
+        //                 [FreshnessPeriod]
+        //				   [NackHeader]
+        //                 <Payload>
+        //             }
+        /////////////////////////////////////////////////////////////
+        this.minPacket.readOnlyField.clearBlocks();
+
+        // FreshnessPeriod
+        if(this.freshnessPeriod.isInitial()){
+            block=new SelfEncodingBase().selfWireEncode(this.freshnessPeriod);
+            if(block==null){
+                return false;
+            }
+            this.minPacket.readOnlyField.addBlock(block);
+        }
+
+        // NackHeader
+        if(this.nackHeader.isInitial()){
+            block=new SelfEncodingBase().selfWireEncode(this.nackHeader);
+            if(block==null){
+                return false;
+            }
+            this.minPacket.readOnlyField.addBlock(block);
+        }
+
+        // Payload
+        block=new SelfEncodingBase().selfWireEncode(this.payload);
+        if(block==null){
+            return false;
+        }
+        this.minPacket.readOnlyField.addBlock(block);
+
+        /////////////////////////////////////////////////////////////
+        //// 填充标识区
+        /////////////////////////////////////////////////////////////
+        this.minPacket.identifierField.clearIdentifiers();
+        IdentifierWrapper identifierWrapper=
+                new IdentifierWrapper().createContentInterestIdentifierByComponents(this.name.getComponents());
+        if(identifierWrapper==null){
+            return false;
+        }
+        this.minPacket.identifierField.addIdentifier(identifierWrapper);
+
+        return true;
+    }
+
+    /**
+     * 从 MINPacket 的分区中提取出 Data 的各项属性
+     * @return
+     */
+    @Override
+    public boolean extraDataFromFields() {
+        /////////////////////////////////////////////////////////////
+        //// 解析可变区
+        //             {                             => 可变区
+        //                 {                         => 受保护区
+        //                     [CongestionMark]
+        //                 }
+        //                 {                         => 非受保护区
+        //                     "Empty"
+        //                 }
+        //             }
+        /////////////////////////////////////////////////////////////
+        Block block=this.minPacket.mutableField.mutableProtectField.getBlockByType(new VlInt(TLV.TlvCongestionMark));
+        if(block!=null){
+            if(!this.congestionMark.wireDecode(block)){
+                return false;
+            }
+        }
+
+        /////////////////////////////////////////////////////////////
+        //// 解析只读区
+        //             {                             => 只读区
+        //                 [FreshnessPeriod]
+        //                 <Payload>
+        //             }
+        /////////////////////////////////////////////////////////////
+        ElementContainer elementContainer=this.minPacket.readOnlyField.getBlocks();
+        int len=elementContainer.length();
+        for (int i = 0; i < len; i++) {
+            Block newblock=elementContainer.getBlock(i);
+            int type;
+            try {
+                type=newblock.getType().getVlIntValue2Int();
+            } catch (VlIntException e) {
+                throw new Error("Data.extraDataFromFields: "+e.getMessage());
+            }
+            switch (type){
+                case TLV.TlvFreshnessPeriod:
+                    if(!this.freshnessPeriod.wireDecode(newblock)){
+                        return false;
+                    }
+                case TLV.TlvPayload:
+                    if(!this.payload.wireDecode(newblock)){
+                        return false;
+                    }
+                 default:
+                     // TODO: 这边可以规定哪些范围是自定义的，哪些是预留的，然后根据需要这边抛出错误
+
+            }
+        }
+
+        /////////////////////////////////////////////////////////////
+        //// 解析标识区
+        /////////////////////////////////////////////////////////////
+        IdentifierWrapper interestIdentifierWrapper=
+                this.minPacket.identifierField.getIdentifierByType(new VlInt(TLV.TlvIdentifierContentInterest));
+        if(interestIdentifierWrapper==null){
+            return false;
+        }
+        this.setName(interestIdentifierWrapper.getIdentifier());
+
+        return true;
+    }
+
+    /**
+     * 将 Data 线速编码为一个 TLV
+     * @param encoder
+     * @return
+     */
+    @Override
+    public int wireEncode(Encoder encoder) {
+        // 首先将各项属性填充到分区当中
+        if(this.fillDataToFields()){
+            return 0;
+        }
+
+        // 指定包类型
+        this.minPacket.packetType=new VlInt(TLV.TlvPacketMINCommon);
+
+        return this.minPacket.wireEncode(encoder);
+    }
+
+    /**
+     * 从 TLV Block 中解码出一个 Data
+     * @param block
+     * @return
+     */
+    @Override
+    public boolean wireDecode(Block block) {
+        if(!this.minPacket.wireDecode(block)){
+            return false;
+        }
+        return this.extraDataFromFields();
+    }
+}