MaxOS::processes::resources::BridgeResource Class Reference

A generic wrapper for a Resource that exists on a userspace server which exposes its operations as Resource operations. More...

#include <resource_bridge.h>

Inheritance diagram for MaxOS::processes::resources::BridgeResource:

Public Member Functions
	BridgeResource (const string &name, size_t flags, resource_type_t type)
void	open (size_t flags) final
	Opens the resource.
void	close (size_t flags) final
	Closes the resource.
int	read (void *buffer, size_t size, size_t flags) final
	Reads data from the resource.
int	write (const void *buffer, size_t size, size_t flags) final
	write a certain amount of bytes to a resource
void	attach_wrapper (BridgeHandler *wrapper)
bool	get_on_bridge ()
	Attempt to get a resource on a bridge endpoint that may not be registered yet.
void	create_on_bridge ()
	Passes the creation of a resource to the bridge.

Detailed Description

A generic wrapper for a Resource that exists on a userspace server which exposes its operations as Resource operations.

Definition at line 60 of file resource_bridge.h.

Constructor & Destructor Documentation

BridgeResource()

BridgeResource::BridgeResource	(	const string &	name,
		size_t	flags,
		resource_type_t	type
	)

Definition at line 189 of file resource_bridge.cpp.

: Resource(name, flags, type)
{
}

Member Function Documentation

attach_wrapper()

void BridgeResource::attach_wrapper

(

BridgeHandler *

wrapper

)

Definition at line 239 of file resource_bridge.cpp.

                                                          {
 
    m_handler = wrapper;
    m_id = wrapper->allocate_id();
 
}

close()

void BridgeResource::close ( size_t  flags )

final

Closes the resource.

Parameters

flags

Optional flags to pass (unused by default but resource type specific)

Definition at line 210 of file resource_bridge.cpp.

                                       {
     m_handler -> send_to_bridge(m_id, ServiceResourceCommand::R_CLOSE, 0,0, flags);
}

create_on_bridge()

void BridgeResource::create_on_bridge

(

)

Passes the creation of a resource to the bridge.

Definition at line 262 of file resource_bridge.cpp.

                                      {
 
    // Let the bridge construct the object on its end
    m_handler -> send_to_bridge(m_id, ServiceResourceCommand::S_CREATE, name().c_str(),name().length() + 1, 0);
 
}

get_on_bridge()

bool BridgeResource::get_on_bridge

(

)

Attempt to get a resource on a bridge endpoint that may not be registered yet.

Returns

True if the resource can be fetched, False otherwise

Definition at line 251 of file resource_bridge.cpp.

                                   {
 
   // Let the bridge get the object on its end
   return m_handler -> send_to_bridge(m_id, ServiceResourceCommand::S_GET, name().c_str(),name().length() + 1, 0) > 0;
 
 
}

open()

void BridgeResource::open ( size_t  flags )

final

Opens the resource.

Parameters

flags

Optional flags to pass (unused by default but resource type specific)

Definition at line 201 of file resource_bridge.cpp.

                                      {
     m_handler -> send_to_bridge(m_id, ServiceResourceCommand::R_OPEN, 0,0, flags);
}

read()

int BridgeResource::read ( void *  buffer, size_t  size, size_t  flags  )

final

Reads data from the resource.

Parameters

buffer	The buffer to read into
size	The number of bytes to read
flags	The flags to pass to the reading

Returns

The number of bytes successfully read or -1 on error

Definition at line 223 of file resource_bridge.cpp.

                                                                {
    return m_handler -> send_to_bridge(m_id, ServiceResourceCommand::R_READ, buffer, size, flags);
}

write()

int BridgeResource::write ( const void *  buffer, size_t  size, size_t  flags  )

final

write a certain amount of bytes to a resource

Parameters

buffer	The buffer to read from
size	How many bytes to write
flags	Optional flags to pass (unused by default but resource type specific)

Returns

How many bytes were successfully written

Definition at line 235 of file resource_bridge.cpp.

                                                                       {
    return m_handler -> send_to_bridge(m_id, ServiceResourceCommand::R_WRITE, buffer, size, flags);
}

---

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

• /home/runner/work/MaxOS/MaxOS/kernel/include/processes/resources/resource_bridge.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/processes/resources/resource_bridge.cpp