Chromium Embedded Framework (CEF)  117.1.0+ga287baf+chromium-117.0.5938.62
CefSharedProcessMessageBuilder Class Referenceabstract

Class that builds a CefProcessMessage containing a shared memory region. More...

#include "include/cef_shared_process_message_builder.h"

Inheritance diagram for CefSharedProcessMessageBuilder:
CefBaseRefCounted

Public Member Functions

virtual bool IsValid ()=0
 Returns true if the builder is valid. More...
 
virtual size_t Size ()=0
 Returns the size of the shared memory region in bytes. More...
 
virtual void * Memory ()=0
 Returns the pointer to the writable memory. More...
 
virtual CefRefPtr< CefProcessMessageBuild ()=0
 Creates a new CefProcessMessage from the data provided to the builder. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Static Public Member Functions

static CefRefPtr< CefSharedProcessMessageBuilderCreate (const CefString &name, size_t byte_size)
 Creates a new CefSharedProcessMessageBuilder with the specified |name| and shared memory region of specified |byte_size|. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Class that builds a CefProcessMessage containing a shared memory region.

This class is not thread-safe but may be used exclusively on a different thread from the one which constructed it.

Member Function Documentation

◆ Build()

virtual CefRefPtr<CefProcessMessage> CefSharedProcessMessageBuilder::Build ( )
pure virtual

Creates a new CefProcessMessage from the data provided to the builder.

Returns nullptr for invalid instances. Invalidates the builder instance.

◆ Create()

static CefRefPtr<CefSharedProcessMessageBuilder> CefSharedProcessMessageBuilder::Create ( const CefString name,
size_t  byte_size 
)
static

Creates a new CefSharedProcessMessageBuilder with the specified |name| and shared memory region of specified |byte_size|.

◆ IsValid()

virtual bool CefSharedProcessMessageBuilder::IsValid ( )
pure virtual

Returns true if the builder is valid.

◆ Memory()

virtual void* CefSharedProcessMessageBuilder::Memory ( )
pure virtual

Returns the pointer to the writable memory.

Returns nullptr for invalid instances. The returned pointer is only valid for the life span of this object.

◆ Size()

virtual size_t CefSharedProcessMessageBuilder::Size ( )
pure virtual

Returns the size of the shared memory region in bytes.

Returns 0 for invalid instances.


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