Lines Matching +full:is +full:- +full:stream

1 .TH SG_STREAM_CTL "8" "March 2018" "sg3_utils\-1.43" SG3_UTILS
3 sg_stream_ctl \- send SCSI STREAM CONTROL or GET STREAM STATUS command
6 [\fI\-\-brief\fR] [\fI\-\-close\fR] [\fI\-\-ctl=CTL\fR] [\fI\-\-get\fR]
7 [\fI\-\-help\fR] [\fI\-\-id=SID\fR] [\fI\-\-maxlen=LEN\fR] [\fI\-\-open\fR]
8 [\fI\-\-readonly\fR] [\fI\-\-verbose\fR] [\fI\-\-version\fR] \fIDEVICE\fR
12 Sends a SCSI STREAM CONTROL or GET STREAM STATUS command to the \fIDEVICE\fR.
13 These commands, together with WRITE STREAM(16 and 32) and several fields in
15 The stream commands were added in SBC\-4 draft 8 (September 2015).
17 Both STREAM CONTROL and GET STREAM STATUS commands expect data from the
18 \fIDEVICE\fR (referred to as 'data\-in'). In the case of STREAM CONTROL
19 only the 'open' (STR_CTL<\-\-0x1) actually needs the data\-in as it contains
20 the "Assigned stream id" if the open was successful. The assigned stream
21 id should be used by subsequent WRITE STREAM commands and ultimately
22 by the STREAM CONTROL close (STR_CTL<\-\-0x2). Valid stream ids are between
27 \fB\-b\fR, \fB\-\-brief\fR
28 this option reduces the output of the GET STREAM STATUS command to just
30 currently open stream ids. If an error occurs then \-1 is sent to stdout
31 and error related messages are sent to stderr. The default is to print more
32 words (and fields) from the GET STREAM STATUS response.
34 \fB\-c\fR, \fB\-\-close\fR
35 selects the STREAM CONTROL command and sets STR_CTL<\-\-0x2 (i.e. 'close').
36 The \fI\-\-id=SID\fR option should also be given because it defaults to 0
37 which is not a valid stream id.
39 \fB\-C\fR, \fB\-\-ctl\fR=\fICTL\fR
40 \fICTL\fR is the value placed in the STR_CTL field of the STREAM CONTROL
41 command (cdb). It is a two bit field so has 4 variants: 0 and 3 are reserved;
42 1 opens are new stream and 2 closes the given stream id. '\-\-ctl=1' is
43 equivalent to '\-\-open' while '\-\-ctl=2' is equivalent to '\-\-close'.
45 \fB\-g\fR, \fB\-\-get\fR
46 selects the GET STREAM STATUS command. If the \fI\-\-id=SID\fR option is
47 also given the the response starts lists open stream ids from and including
48 \fISID\fR. If the \fI\-\-id=SID\fR option is not given (or \fISID\fR is 0)
49 then all open stream id will be returned in the response (data\-in) as long
51 the \fI\-\-maxlen=LEN\fR option) is long enough. This is the default action
52 of this utility (i.e. GET STREAM STATUS command) if no "selecting" options
55 \fB\-h\fR, \fB\-\-help\fR
58 \fB\-i\fR, \fB\-\-id\fR=\fISID\fR
59 \fISID\fR is a stream id, a value between 1 and 65535. It is used by STREAM
60 CONTROL (close) to identify the stream to close. It is used by the GET
61 STREAM STATUS command as the starting stream id (from and including); so
62 stream ids that are less than \fISID\fR will not appear in the response.
64 \fB\-m\fR, \fB\-\-maxlen\fR=\fILEN\fR
65 \fILEN\fR is the maximum length the response can be. It becomes the
67 this option) is 8 bytes for STREAM CONTROL and 248 bytes for GET STREAM
70 \fB\-o\fR, \fB\-\-open\fR
71 selects the STREAM CONTROL command and sets STR_CTL<\-\-0x1 (i.e. 'open').
72 If the \fI\-\-id=SID\fR option is given then it is ignored. The user should
73 observe the response as the "Assigned stream id" is printed on stdout if
74 the open is successful, if not '\-1' is sent to stdout and error messages are
75 sent to stderr. If the \fI\-\-brief\fR option is also given then the only
76 thing sent to stdout is a number of the assigned stream id (1 to
77 65535 inclusive) or '\-1' if there is an error.
79 \fB\-r\fR, \fB\-\-readonly\fR
80 this option sets a 'read\-only' flag when the underlying operating system
82 not easily determine whether a pass\-through command is a logical read or
84 stance and require read\-write type permissions on the \fIDEVICE\fR open
85 irrespective of what is performed by the pass\-through.
87 \fB\-v\fR, \fB\-\-verbose\fR
90 \fB\-V\fR, \fB\-\-version\fR
94 READs (6, 10, 12, 16 or 32) can be used. Note that when a stream is closed,
95 all resources associated with that stream id are removed, apart from the
96 data in the written LBAs. To make sure the reading back data is not delayed
98 set the RECOVERY TIME LIMIT field (RTL, units for non\-zero values:
99 milliseconds) in the 'Read\-write error recovery' mode page. This can be done
102 The SCSI WRITE STREAM (16 and 32) commands can be found in the sg_write_x
105 The exit status of sg_stream_ctl is 0 when it is successful. Otherwise see
114 This software is distributed under a BSD\-2\-Clause license. There is NO