The chrome-native-messaging Reference Manual

Table of Contents

The chrome-native-messaging Reference Manual

This is the chrome-native-messaging Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:25:35 2021 GMT+0.

1 Introduction

chrome-native-messaging

Communicate with Chromium or Google Chrome extensions, as a native application.

For more information on what I mean, please look at nativeMessaging documentation.

API

This package provides 2 functions: read-from-ext and send-to-ext.

read-from-ext

(defun read-from-ext (stream)
  "Reads the string sent from the extension. The stream is usually *standard-input*.")

A typical call to this function looks like this (using the jsown package to parse the JSON):

(let* ((buffer (chromium-native-messaging:read-from-ext *standard-input*))
       (json-object (jsown:parse buffer)))
  ; code
  )

send-to-ext

(defun send-to-ext (string output-stream)
  "Sends a string to the extension. Usually, output-stream is *standard-output*.")

A typical call looks like this (again, using the jsown package):

(chrome-native-messaging:send-to-ext
 (jsown:to-json
  (jsown:new-js
    ("foo" "bar")))
 *standard-output*)

License

MIT license.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 chrome-native-messaging

Author

Florian Margaine <florian@margaine.com>

License

MIT License

Description

A package to communicate with a Chrome extension as the native application

Dependency

trivial-utf-8

Source

chrome-native-messaging.asd (file)

Components

• package.lisp (file)
• read.lisp (file)
• send.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 chrome-native-messaging.asd

Location

chrome-native-messaging.asd

Systems

chrome-native-messaging (system)

3.1.2 chrome-native-messaging/package.lisp

Parent

chrome-native-messaging (system)

Location

package.lisp

Packages

chrome-native-messaging

3.1.3 chrome-native-messaging/read.lisp

Dependency

package.lisp (file)

Parent

chrome-native-messaging (system)

Location

read.lisp

Exported Definitions

read-from-ext (function)

Internal Definitions

read-length (function)

3.1.4 chrome-native-messaging/send.lisp

Dependency

read.lisp (file)

Parent

chrome-native-messaging (system)

Location

send.lisp

Exported Definitions

send-to-ext (function)

Internal Definitions

integer-to-bytes (function)

4 Packages

Packages are listed by definition order.

4.1 chrome-native-messaging

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• read-from-ext (function)
• send-to-ext (function)

Internal Definitions

• integer-to-bytes (function)
• read-length (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: read-from-ext STREAM

Reads the string sent from the extension. The stream is usually *standard-input*.

Package

chrome-native-messaging

Source

read.lisp (file)

Function: send-to-ext STRING OUTPUT-STREAM

Sends a string to the extension. Usually, output-stream is *standard-output*.

Package

chrome-native-messaging

Source

send.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: integer-to-bytes INTEGER

Package

chrome-native-messaging

Source

send.lisp (file)

Function: read-length STREAM

Reads the length of the message from the first 4 bytes

Package

chrome-native-messaging

Source

read.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types