File: nbd_stats_bytes_received.pod

package info (click to toggle)
libnbd 1.24.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,956 kB
  • sloc: ansic: 55,158; ml: 12,325; sh: 8,811; python: 4,757; makefile: 3,038; perl: 165; cpp: 24
file content (59 lines) | stat: -rw-r--r-- 1,132 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
=head1 NAME

nbd_stats_bytes_received - statistics of bytes received over connection
so far

=head1 SYNOPSIS

 #include <libnbd.h>

 uint64_t nbd_stats_bytes_received (
            struct nbd_handle *h
          );

=head1 DESCRIPTION

Return the number of bytes that the client has
received from the server.

This tracks the plaintext bytes utilized by the NBD protocol; it
may differ from the number of bytes actually received over the
connection, particularly when TLS is in use.

=head1 RETURN VALUE

This call returns a counter.

=head1 ERRORS

This function does not fail.

The following parameters must not be NULL: C<h>.
For more information see L<libnbd(3)/Non-NULL parameters>.

=head1 VERSION

This function first appeared in libnbd 1.16.

If you need to test if this function is available at compile time
check if the following macro is defined:

 #define LIBNBD_HAVE_NBD_STATS_BYTES_RECEIVED 1

=head1 SEE ALSO

L<nbd_create(3)>,
L<nbd_stats_bytes_sent(3)>,
L<nbd_stats_chunks_received(3)>,
L<nbd_stats_chunks_sent(3)>,
L<libnbd(3)>.

=head1 AUTHORS

Eric Blake

Richard W.M. Jones

=head1 COPYRIGHT

Copyright Red Hat