0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-09 11:31:11 +01:00
construct/include/ircd/net/read.h
2018-01-14 20:45:30 -08:00

116 lines
3.2 KiB
C++

/*
* Copyright (C) 2017 Charybdis Development Team
* Copyright (C) 2017 Jason Volk <jason@zemos.net>
*
* Permission to use, copy, modify, and/or distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice is present in all copies.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#define HAVE_IRCD_NET_READ_H
namespace ircd::net
{
// Non-blocking; read into buffers in a single syscall
size_t read_one(socket &, const vector_view<const mutable_buffer> &);
size_t read_one(socket &, const mutable_buffer &);
// Non-blocking; read as much as possible into buffers
size_t read_any(socket &, const vector_view<const mutable_buffer> &);
size_t read_any(socket &, const mutable_buffer &);
// Yields until something is read into buffers.
size_t read_few(socket &, const vector_view<const mutable_buffer> &);
size_t read_few(socket &, const mutable_buffer &);
// Yields until buffers are entirely full.
size_t read_all(socket &, const vector_view<const mutable_buffer> &);
size_t read_all(socket &, const mutable_buffer &);
// Alias to read_few();
size_t read(socket &, const vector_view<const mutable_buffer> &);
size_t read(socket &, const mutable_buffer &);
// Non-blocking; discard up to len, but less may be discarded.
size_t discard_any(socket &, const size_t &len);
// Yields until len has been discarded
size_t discard_all(socket &, const size_t &len);
}
/// Alias to read_few();
inline size_t
ircd::net::read(socket &socket,
const mutable_buffer &buffer)
{
return read_few(socket, buffer);
}
/// Alias to read_few();
inline size_t
ircd::net::read(socket &socket,
const vector_view<const mutable_buffer> &buffers)
{
return read_few(socket, buffers);
}
inline size_t
ircd::net::read_all(socket &socket,
const mutable_buffer &buffer)
{
const mutable_buffer buffers[]
{
buffer
};
return read_all(socket, buffers);
}
inline size_t
ircd::net::read_few(socket &socket,
const mutable_buffer &buffer)
{
const mutable_buffer buffers[]
{
buffer
};
return read_few(socket, buffers);
}
inline size_t
ircd::net::read_any(socket &socket,
const mutable_buffer &buffer)
{
const mutable_buffer buffers[]
{
buffer
};
return read_any(socket, buffers);
}
inline size_t
ircd::net::read_one(socket &socket,
const mutable_buffer &buffer)
{
const mutable_buffer buffers[]
{
buffer
};
return read_one(socket, buffers);
}