Myth Protocol Command QUERY FILETRANSFER

From MythTV

Contents 1 QUERY_FILETRANSFER 1.1 Present in Protocol Versions 1.2 Arguments 2 IS_OPEN 2.1 Present in Protocol Versions 2.2 Examples 2.3 Description 2.4 Returns 3 DONE 3.1 Present in Protocol Versions 3.2 Examples 3.3 Description 3.4 Returns 4 REQUEST_BLOCK 4.1 Present in Protocol Versions 4.2 Arguments 4.3 Examples 4.4 Description 5 SEEK 5.1 Arguments 5.2 Examples 5.3 Description 6 SET_TIMEOUT 6.1 Present in Protocol Versions 6.2 Arguments 6.3 Examples 6.4 Description

QUERY_FILETRANSFER

Present in Protocol Versions

All?

Arguments

Command arguments: <file socket id>

List arguments: <command>

IS_OPEN

Present in Protocol Versions

All?

Examples

Command:

> QUERY_FILETRANSFER 14[]:[]IS_OPEN

Response:

1

Description

Queries whether a file socket is currently open.

Returns

Successful response:

1

DONE

Present in Protocol Versions

All?

Examples

Command:

> QUERY_FILETRANSFER 14[]:[]DONE

Response:

ok

Description

Closes the file transfer socket

Returns

Always returns

ok

REQUEST_BLOCK

Present in Protocol Versions

All?

Arguments

Command arguments: none

List arguments: <byte count>

Examples

Command:

> QUERY_FILETRANSFER 14[]:[]REQUEST_BLOCK[]:[]10

Response: <count> bytes from the file being transferred

Description

Gets data from the backend

SEEK

Arguments

Command arguments: none

List arguments: <pos1> <pos2> <whence> <curpos1> <curpos2>

Examples

Description

This command wraps the file "seek" function. The pos and curpos fields are combined into a larger "long long" data type. This returns two values, a split "long long" value for the result.

SET_TIMEOUT

Present in Protocol Versions

All?

Arguments

Command arguments: none

List arguments: <whether to have a fast timeout>

Examples

Command:

> QUERY_FILETRANSFER 14[]:[]SET_TIMEOUT[]:[]1

Response:

ok

Description

This command sets whether reading from a file should have a fast or slow timeout. Slow timeouts are used for live TV ring buffers, and is three seconds. Fast timeouts are used for static files, and are 0.12 seconds.