libcamera: include/libcamera/internal/ipc_unixsocket.h Source File

libcamera v0.0.3 Supporting cameras in Linux since 2019

Loading...
Searching...
No Matches
ipc_unixsocket.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2019, Google Inc.
4 *
5 * ipc_unixsocket.h - IPC mechanism based on Unix sockets
6 */
7
8#pragma once
9
10#include <stdint.h>
11#include <sys/types.h>
12#include <vector>
13
14#include <libcamera/base/signal.h>
15#include <libcamera/base/unique_fd.h>
16
17namespace libcamera {
18
19class EventNotifier;
20
21 class IPCUnixSocket
22{
23public:
24 struct Payload {
25 std::vector<uint8_t> data;
26 std::vector<int32_t> fds;
27 };
28
29 IPCUnixSocket();
30 ~IPCUnixSocket();
31
32 UniqueFD create();
33 int bind(UniqueFD fd);
34 void close();
35 bool isBound() const;
36
37 int send(const Payload &payload);
38 int receive(Payload *payload);
39
40 Signal<> readyRead;
41
42private:
43 struct Header {
44 uint32_t data;
45 uint8_t fds;
46 };
47
48 int sendData(const void *buffer, size_t length, const int32_t *fds, unsigned int num);
49 int recvData(void *buffer, size_t length, int32_t *fds, unsigned int num);
50
51 void dataNotifier();
52
53 UniqueFD fd_;
54 bool headerReceived_;
55 struct Header header_;
56 EventNotifier *notifier_;
57};
58
59} /* namespace libcamera */
libcamera::EventNotifier
Notify of activity on a file descriptor.
Definition: event_notifier.h:20
libcamera::IPCUnixSocket
IPC mechanism based on Unix sockets.
Definition: ipc_unixsocket.h:22
libcamera::IPCUnixSocket::receive
int receive(Payload *payload)
Receive a message payload.
Definition: ipc_unixsocket.cpp:216
libcamera::IPCUnixSocket::send
int send(const Payload &payload)
Send a message payload.
Definition: ipc_unixsocket.cpp:174
libcamera::IPCUnixSocket::isBound
bool isBound() const
Check if the IPC channel is bound.
Definition: ipc_unixsocket.cpp:159
libcamera::IPCUnixSocket::close
void close()
Close the IPC channel.
Definition: ipc_unixsocket.cpp:143
libcamera::IPCUnixSocket::bind
int bind(UniqueFD fd)
Bind to an existing IPC channel.
Definition: ipc_unixsocket.cpp:126
libcamera::IPCUnixSocket::create
UniqueFD create()
Create an new IPC channel.
Definition: ipc_unixsocket.cpp:92
libcamera::IPCUnixSocket::readyRead
Signal readyRead
A Signal emitted when a message is ready to be read.
Definition: ipc_unixsocket.h:40
libcamera::Signal
Generic signal and slot communication mechanism.
Definition: signal.h:39
libcamera::UniqueFD
unique_ptr-like wrapper for a file descriptor
Definition: unique_fd.h:18
libcamera
Top-level libcamera namespace.
Definition: backtrace.h:17
signal.h
Signal & slot implementation.
libcamera::IPCUnixSocket::Payload
Container for an IPC payload.
Definition: ipc_unixsocket.h:24
libcamera::IPCUnixSocket::Payload::fds
std::vector< int32_t > fds
Array of file descriptors to cross IPC boundary.
Definition: ipc_unixsocket.h:26
libcamera::IPCUnixSocket::Payload::data
std::vector< uint8_t > data
Array of bytes to cross IPC boundary.
Definition: ipc_unixsocket.h:25
unique_fd.h
File descriptor wrapper that owns a file descriptor.