PuppeteerClient

PuppeteerCommunicator - The CDP Transport Layer

PuppeteerCommunicator is the lowest-level layer in GPAL's browser stack - a managed websocket connection that speaks the Chrome DevTools Protocol directly, used internally by PuppeteerClient and the Puppeteer-based automation engines.

PuppeteerCommunicator owns the websocket (or pipe) connection to the browser's DevTools endpoint, tracks frame/context/session IDs, queues CDP events, and matches asynchronous CDP responses back to the calls that requested them. browser.PuppeteerCommunicator exposes this connection on a live Browser instance using a Puppeteer-based engine (PuppeteerPort, PuppeteerPortHW, PuppeteerPipe, PuppeteerPipeHW). PuppeteerClient is built on top of PuppeteerCommunicator - every PuppeteerClient endpoint ultimately becomes one or more raw CDP commands sent through PuppeteerCommunicator and resolved against its response/event queues. Like PuppeteerClient, this is a completely custom CDP implementation written for GPAL - not derived from, or dependent on, the Node.js Puppeteer library or any third-party .NET Puppeteer package.

TIP

Most workflows never touch PuppeteerCommunicator directly - PuppeteerClient and the Browser fluent API cover the vast majority of CDP operations. Reach for PuppeteerCommunicator only when you need a CDP domain/method that has no PuppeteerClient endpoint yet, or when building new PuppeteerClient endpoint mappings.

WARNING

PuppeteerCommunicator's members are largely internal and intended for extending GPAL itself rather than for application workflows. Method signatures here may change between releases without the same compatibility guarantees as the Browser, RESTClient, and PuppeteerClient fluent APIs.

Examples

GPAL Fluent: High-level fluent C# API

//PuppeteerCommunicator manages one websocket session per Browser, including target/session switching for tabs, windows, iframes, and shadow DOM. PuppeteerClient endpoint implementations call PuppeteerCommunicator's methods (such as QuerySelector, Click, Evaluate at the CDP level) and translate the raw CDP responses into the values PuppeteerClient.Execute returns.

// Accessing the underlying CDP connection from a live Browser var browser = GPAL.Browser .WithUseAutomationEngine(AutomationEngine.PuppeteerPort) .GoTo("https://example.com") .ToGPALObject(); var communicator = browser.PuppeteerCommunicator; // PuppeteerClient endpoint calls run through this same connection string elementId = browser.PuppeteerClient .QuerySelector("#main") .Execute();

Documentation Example

Documentation

Showing off some plain text in these paragraphs eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Other formats

Here you can find different accents and emphasis sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

This is a link and how it could look like bestlinkinthebeautifulworld. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Here's just some classic bold text adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam notBoldSecondbestlinkinthebeautifulworld illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at adipisicing elit libero vel voluptas? Expedita, adipisicing facere dolores voluptatem ad ab rem assumenda soluta!

Other cuple of colors in case we want to emphasize several ways adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at voluptatem libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Adding Images to the content

Lorem ipsum dolor sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta! Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quod veniam, quam ad expedita laborum sed at voluptates culpa ipsam ut vel. Ullam temporibus a mollitia quod aliquam ratione exercitationem nesciunt.

Coding Blocks

Lorem ipsum dolor sit amet consectetur adipisicing elit. Repudiandae quas consequuntur illo numquam assumenda autem exercitationem distinctio perspiciatis in natus. Eius dicta similique ipsam ipsa minima, nemo quae enim tempore.

GPAL

.CallIfNotFound(GenericCallIfNotFound)

.WithPublishToConsole();

//System.Drawing.Rectangle windowSize = new System.Drawing.Rectangle(10, 10, 1500, 1024);

// NOTE: we have to set browser = before we execute any steps

// this is due to the 'GenericCallIfNotFound' which might throw an exception, and BankScraper will not have the browser set when it calls scraper.Close()

// until the complete fluent line gets executed (meaning every step, meaning browser is not set until everything else succeeds)

browser = GPAL.Browser

.WithBrowserType(Enums.BrowserType.Chrome)

.WithProfileDataDirectory(ChromeProfileLocation)

.WithUseAutomationEngine(AutomationEngine.Selenium)

.WithWindowSize(new System.Drawing.Rectangle(0,0,1920,1080))

.ToGPALObject();

PuppeteerClient

PuppeteerClient

PuppeteerCommunicator - The CDP Transport Layer

Examples

Documentation Example

Documentation

Category

Endpoint

Enpoint

Enpoint

Enpoint

Other formats

Adding Images to the content

Coding Blocks

On this page