Blame doc/functions/gnutls_range_split

Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
Packit Service 4684c1
@deftypefun {int} {gnutls_range_split} (gnutls_session_t @var{session}, const gnutls_range_st * @var{orig}, gnutls_range_st * @var{next}, gnutls_range_st * @var{remainder})
Packit Service 4684c1
@var{session}: is a @code{gnutls_session_t}  type
Packit Service 4684c1
Packit Service 4684c1
@var{orig}: is the original range provided by the user
Packit Service 4684c1
Packit Service 4684c1
@var{next}: is the returned range that can be conveyed in a TLS record
Packit Service 4684c1
Packit Service 4684c1
@var{remainder}: is the returned remaining range
Packit Service 4684c1
Packit Service 4684c1
This function should be used when it is required to hide the length
Packit Service 4684c1
of very long data that cannot be directly provided to @code{gnutls_record_send_range()} .
Packit Service 4684c1
In that case this function should be called with the desired length
Packit Service 4684c1
hiding range in  @code{orig} . The returned  @code{next} value should then be used in
Packit Service 4684c1
the next call to @code{gnutls_record_send_range()}  with the partial data.
Packit Service 4684c1
That process should be repeated until  @code{remainder} is (0,0).
Packit Service 4684c1
Packit Service 4684c1
@strong{Returns:} 0 in case splitting succeeds, non zero in case of error.
Packit Service 4684c1
Note that  @code{orig} is not changed, while the values of  @code{next} and  @code{remainder} are modified to store the resulting values.
Packit Service 4684c1
@end deftypefun