mirror of
https://github.com/justinian/jsix.git
synced 2025-12-10 00:14:32 -08:00
b8684777e0
This commit adds a new flag, j6_channel_block, and a new flags param to the channel_receive syscall. When the block flag is specified, the caller will block waiting for data on the channel if the channel is empty.
56 lines
1.5 KiB
C++
56 lines
1.5 KiB
C++
#pragma once
|
|
/// \file channel.h
|
|
/// Definition of channel objects and related functions
|
|
|
|
#include <j6/caps.h>
|
|
#include <util/bip_buffer.h>
|
|
#include <util/counted.h>
|
|
#include <util/spinlock.h>
|
|
|
|
#include "objects/kobject.h"
|
|
#include "wait_queue.h"
|
|
|
|
namespace obj {
|
|
|
|
/// Channels are uni-directional means of sending data
|
|
class channel :
|
|
public kobject
|
|
{
|
|
public:
|
|
/// Capabilities on a newly constructed channel handle
|
|
constexpr static j6_cap_t creation_caps = j6_cap_channel_all;
|
|
|
|
channel();
|
|
virtual ~channel();
|
|
|
|
static constexpr kobject::type type = kobject::type::channel;
|
|
|
|
/// Put a message into the channel
|
|
/// \arg data Buffer of data to write
|
|
/// \returns The number of bytes successfully written
|
|
size_t enqueue(const util::buffer &data);
|
|
|
|
/// Get a message from the channel, copied into a provided buffer
|
|
/// \arg buffer The buffer to copy data into
|
|
/// \arg block If true, block the calling thread until there is data
|
|
/// \returns The number of bytes copied into the provided buffer
|
|
size_t dequeue(util::buffer buffer, bool block = false);
|
|
|
|
/// Mark this channel as closed, all future calls to enqueue or
|
|
/// dequeue messages will fail with j6_status_closed.
|
|
void close();
|
|
|
|
/// Check if this channel has been closed.
|
|
inline bool closed() const { return m_closed; }
|
|
|
|
private:
|
|
size_t m_len;
|
|
uintptr_t m_data;
|
|
bool m_closed;
|
|
util::bip_buffer m_buffer;
|
|
util::spinlock m_close_lock;
|
|
wait_queue m_queue;
|
|
};
|
|
|
|
} // namespace obj
|