Mirror of :pserver:cvs@cvs.fefe.de:/cvs libowfat https://www.fefe.de/libowfat/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

29 lines
1.1 KiB

  1. .TH buffer_get_token_sa 3
  2. .SH NAME
  3. buffer_get_token_sa \- read token from buffer
  4. .SH SYNTAX
  5. .nf
  6. .B #include <stralloc.h>
  7. .B #include <buffer.h>
  8. int \fBbuffer_get_token_sa\fP(buffer* \fIb\fR,stralloc* \fIsa\fR,
  9. const char* \fIcharset\fR,unsigned long int \fIsetlen\fR);
  10. .SH DESCRIPTION
  11. buffer_get_token_sa appends data from the \fIb\fR to \fIsa\fR until one
  12. of the delimiters in \fIcharset\fR is found, NOT overwriting the
  13. previous content of \fIsa\fR. That delimiter is also appended to
  14. \fIsa\fR.
  15. If reading from the buffer or allocating memory fails,
  16. buffer_get_token_sa returns -1 and sets \fIerrno\fR appropriately. At
  17. that point \fIsa\fR may already contain a partial token.
  18. .SH "RETURN VALUE"
  19. -1 on error (setting errno), 0 on EOF, 1 when successful.
  20. .SH RATIONALE
  21. buffer_get_token_sa appends instead of overwriting so it can be used on
  22. non-blocking sockets (these signal error and set \fIerrno\fR to EAGAIN;
  23. in this case you can simply call buffer_get_token_sa again when
  24. \fBselect\fR or \fBpoll\fR indicate more data is available).
  25. .SH "SEE ALSO"
  26. buffer_getline_sa(3), buffer_get_token(3), buffer(3)