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

libcamera v0.7.1 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 mechanism based on Unix sockets
6 */
7
8#pragma once
9
10#include <memory>
11#include <stdint.h>
12#include <sys/types.h>
13#include <vector>
14
15#include <libcamera/base/signal.h>
16#include <libcamera/base/unique_fd.h>
17
18namespace libcamera {
19
20class EventNotifier;
21
22 class IPCUnixSocket
23{
24public:
25 struct Payload {
26 std::vector<uint8_t> data;
27 std::vector<int32_t> fds;
28 };
29
30 IPCUnixSocket();
31 ~IPCUnixSocket();
32
33 UniqueFD create();
34 int bind(UniqueFD fd);
35 void close();
36 bool isBound() const;
37
38 int send(const Payload &payload);
39 int receive(Payload *payload);
40
41 Signal<> readyRead;
42
43private:
44 struct Header {
45 uint32_t data;
46 uint8_t fds;
47 };
48
49 int sendData(const void *buffer, size_t length, const int32_t *fds, unsigned int num);
50 int recvData(void *buffer, size_t length, int32_t *fds, unsigned int num);
51
52 void dataNotifier();
53
54 UniqueFD fd_;
55 bool headerReceived_;
56 struct Header header_;
57 std::unique_ptr<EventNotifier> notifier_;
58};
59
60} /* namespace libcamera */
libcamera::EventNotifier
Notify of activity on a file descriptor.
Definition event_notifier.h:20
libcamera::IPCUnixSocket::receive
int receive(Payload *payload)
Receive a message payload.
Definition ipc_unixsocket.cpp:216
libcamera::IPCUnixSocket::readyRead
Signal readyRead
A Signal emitted when a message is ready to be read.
Definition ipc_unixsocket.h:41
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:144
libcamera::IPCUnixSocket::bind
int bind(UniqueFD fd)
Bind to an existing IPC channel.
Definition ipc_unixsocket.cpp:127
libcamera::IPCUnixSocket::create
UniqueFD create()
Create an new IPC channel.
Definition ipc_unixsocket.cpp:93
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:17
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:25
libcamera::IPCUnixSocket::Payload::fds
std::vector< int32_t > fds
Array of file descriptors to cross IPC boundary.
Definition ipc_unixsocket.h:27
libcamera::IPCUnixSocket::Payload::data
std::vector< uint8_t > data
Array of bytes to cross IPC boundary.
Definition ipc_unixsocket.h:26
unique_fd.h
File descriptor wrapper that owns a file descriptor.