Difference between revisions of "QUERY FREE SPACE (Myth Protocol)"

From MythTV Official Wiki
Jump to: navigation, search
(adding another example responce that doesnt match the current)
(updated for protocol 66)
 
(8 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
=== Present in Protocol Versions ===
 
=== Present in Protocol Versions ===
 
All?
 
All?
 +
 +
=== Description ===
 +
Queries the backend for information on the local storage devices
 +
 +
== QUERY_FREE_SPACE_LIST ==
 +
 +
=== Present in Protocol Versions ===
 +
Beginning with version 40?
 +
 +
=== Description ===
 +
Queries the backend for information on all storage devices.  Paths existing on the same physical drive will be combined, along with a 'TotalDislSpace' summary as the last device.
 +
 +
== General ==
  
 
=== Arguments ===
 
=== Arguments ===
Line 16: Line 29:
 
Response from proto version 34 with storage groups:
 
Response from proto version 34 with storage groups:
 
<pre>170    theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]0[]:[]63799104[]:[]0[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]0[]:[]75884640[]:[]0[]:[]73477128</pre>
 
<pre>170    theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]0[]:[]63799104[]:[]0[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]0[]:[]75884640[]:[]0[]:[]73477128</pre>
 +
Response from proto version 47 with storage group ID and file system block size:
 +
<pre>206    theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]12[]:[]131072[]:[]0[]:[]63799104[]:[]0[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]13[]:[]131072[]:[]0[]:[]75884640[]:[]0[]:[]73477128</pre>
 +
Response from proto version 66:
 +
<pre>182    theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]12[]:[]131072[]:[]63799104[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]13[]:[]131072[]:[]75884640[]:[]73477128</pre>
  
=== Description ===
 
Queries the backend for how much space is available on the device being used to store recordings
 
  
 
=== Returns ===
 
=== Returns ===
  
 +
#Hostname of the drive
 +
#Path of the drive
 +
#Whether the drive is local to the connected backend
 +
#Drive number (always -1 for QUERY_FREE_SPACE)
 +
#Storage group ID
 +
#Filesystem block size (in bytes)
 
#The total size of the drive, in 1K blocks (64-bit value)
 
#The total size of the drive, in 1K blocks (64-bit value)
 
#The space used on the drive, in 1K blocks (64-bit value)
 
#The space used on the drive, in 1K blocks (64-bit value)
 +
 +
 +
=== Changelog ===
 +
{| border="1" cellspacing="0" cellpadding="5" style="border-collapse:collapse; border-color:#8eabd0; background:#e7edf5"
 +
|- style="background: lightsteelblue"
 +
|+
 +
! version !! changeset !! field count !! description
 +
|-
 +
| 17 || {{changeset|6482}} || 9
 +
| initial version
 +
|-
 +
| 47 || {{changeset|21298}} || 10
 +
| add filesystem block size
 +
|-
 +
| 66 || {{gitcommit|1508085e|mythtv|v0.25pre-2052-g1508085}} || 8
 +
| The sizes are now returned as single 64 bit numbers rather than split into 32 bit numbers.
 +
|-
 +
|}
 +
 +
[[Category:Myth Protocol Commands]]

Latest revision as of 16:49, 6 June 2011

QUERY_FREE_SPACE

Present in Protocol Versions

All?

Description

Queries the backend for information on the local storage devices

QUERY_FREE_SPACE_LIST

Present in Protocol Versions

Beginning with version 40?

Description

Queries the backend for information on all storage devices. Paths existing on the same physical drive will be combined, along with a 'TotalDislSpace' summary as the last device.

General

Arguments

Command arguments: none

List arguments: none

Examples

Command:

16      QUERY_FREE_SPACE

Response:

34      0[]:[]196014080[]:[]0[]:[]29351936

Response from proto version 34 with storage groups:

170     theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]0[]:[]63799104[]:[]0[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]0[]:[]75884640[]:[]0[]:[]73477128

Response from proto version 47 with storage group ID and file system block size:

206     theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]12[]:[]131072[]:[]0[]:[]63799104[]:[]0[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]13[]:[]131072[]:[]0[]:[]75884640[]:[]0[]:[]73477128

Response from proto version 66:

182     theP4[]:[]/media/mainlv/mythtv[]:[]1[]:[]-1[]:[]12[]:[]131072[]:[]63799104[]:[]61376252[]:[]theP4[]:[]/media/disk/mythtv/data[]:[]0[]:[]-1[]:[]13[]:[]131072[]:[]75884640[]:[]73477128


Returns

  1. Hostname of the drive
  2. Path of the drive
  3. Whether the drive is local to the connected backend
  4. Drive number (always -1 for QUERY_FREE_SPACE)
  5. Storage group ID
  6. Filesystem block size (in bytes)
  7. The total size of the drive, in 1K blocks (64-bit value)
  8. The space used on the drive, in 1K blocks (64-bit value)


Changelog

version changeset field count description
17 [6482] 9 initial version
47 [21298] 10 add filesystem block size
66 [v0.25pre-2052-g1508085] 8 The sizes are now returned as single 64 bit numbers rather than split into 32 bit numbers.