iox2::FileDescriptorView Class Reference

A view to a [FileDescriptor]. More...

#include <file_descriptor.hpp>

Inheritance diagram for iox2::FileDescriptorView:

Public Member Functions
auto	file_descriptor () const -> FileDescriptorView override
	Returns a [FileDescriptorView] to the underlying [FileDescriptor].
auto	unsafe_native_handle () const -> int32_t
Public Member Functions inherited from iox2::FileDescriptorBased
	FileDescriptorBased ()=default
	FileDescriptorBased (const FileDescriptorBased &)=default
	FileDescriptorBased (FileDescriptorBased &&)=default
auto	operator= (const FileDescriptorBased &) -> FileDescriptorBased &=default
auto	operator= (FileDescriptorBased &&) -> FileDescriptorBased &=default
virtual	~FileDescriptorBased ()=default

Friends
template<ServiceType >
class	WaitSet
class	FileDescriptor
template<ServiceType >
class	Listener

Detailed Description

A view to a [FileDescriptor].

Definition at line 37 of file file_descriptor.hpp.

Member Function Documentation

file_descriptor()

auto iox2::FileDescriptorView::file_descriptor ( ) const -> FileDescriptorView

overridevirtual

Returns a [FileDescriptorView] to the underlying [FileDescriptor].

Implements iox2::FileDescriptorBased.

unsafe_native_handle()

auto iox2::FileDescriptorView::unsafe_native_handle

(

)

const -> int32_t

Returns the underlying [FileDescriptor] value.

Safety

• the user shall not store the value in a variable otherwise lifetime issues may be encountered
• do not manually close the file descriptor with a sys call

Friends And Related Symbol Documentation

FileDescriptor

friend class FileDescriptor

friend

Definition at line 55 of file file_descriptor.hpp.

Listener

template<ServiceType >

friend class Listener

friend

Definition at line 57 of file file_descriptor.hpp.

WaitSet

template<ServiceType >

friend class WaitSet

friend

Definition at line 54 of file file_descriptor.hpp.

---

The documentation for this class was generated from the following file:

• iox2/file_descriptor.hpp