CRecordFileStoreGetChunk: Get a file chunk from a network file store.

This is an internal message from FileStores.

FileStores don't transmit entire files at once to avoid clogging network lines. Every file download is split into many small chunks. This message is used to retrieve one chunk of a file from another FileStore.

{
    "id": "60ff0699-bca8-400b-a997-7a1bbb8724c9",
    "name": "FILE_STORE_GET_CHUNK",
    "description": "Get a file chunk from a network file store.",
    "isNanoService": "false",
    "type": "REQUEST",
    "slots": [
        {
            "key": "hash",
            "name": "HASH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "STRING",
            "description": "The hash of the file."
            },
        {
            "key": "pos",
            "name": "CHUNK_POSITION",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "LONG",
            "description": "The position of the chunk in the file."
            },
        {
            "key": "len",
            "name": "CHUNK_LENGTH",
            "direction": "REQUEST",
            "presenceConstraint": "MANDATORY",
            "type": "INT",
            "description": "The length of the chunk."
            },
        {
            "key": "bytes",
            "name": "BYTES",
            "direction": "RESPONSE",
            "presenceConstraint": "MANDATORY",
            "type": "BYTE_ARRAY",
            "description": "The bytes (and length) of the chunk."
        }
    ]
}

Slot Description

Key Name Direction Presence Constraint Type Description
hash HASH REQUEST MANDATORY STRING The hash of the file.
pos CHUNK_POSITION REQUEST MANDATORY LONG The position of the chunk in the file.
len CHUNK_LENGTH REQUEST MANDATORY INT The length of the chunk.
bytes BYTES RESPONSE MANDATORY BYTE_ARRAY The bytes (and length) of the chunk.

Record Usage

In nyssr.net, we typically don't exchange interfaces between projects. Instead, we use platform-independent Records to describe message formats.

One or more descriptions of these Records are stored in the JSON or XML format as record.json or record.xml within a directory. The Record Generator, an included Swing tool, generates helper classes from these files. These classes can then be used to type-safely write or read messages.

See also