The chrome-native-messaging Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The chrome-native-messaging Reference Manual

This is the chrome-native-messaging Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:21:21 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 chrome-native-messaging.asd

Location

chrome-native-messaging.asd

Systems

chrome-native-messaging (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 chrome-native-messaging/package.lisp

Parent

chrome-native-messaging (system)

Location

package.lisp

Packages

chrome-native-messaging


Next: , Previous: , Up: Lisp files   [Contents][Index]

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)


Previous: , Up: Lisp files   [Contents][Index]

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)


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 chrome-native-messaging

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
chrome-native-messaging.asd: The chrome-native-messaging<dot>asd file
chrome-native-messaging/package.lisp: The chrome-native-messaging/package<dot>lisp file
chrome-native-messaging/read.lisp: The chrome-native-messaging/read<dot>lisp file
chrome-native-messaging/send.lisp: The chrome-native-messaging/send<dot>lisp file

F
File, Lisp, chrome-native-messaging.asd: The chrome-native-messaging<dot>asd file
File, Lisp, chrome-native-messaging/package.lisp: The chrome-native-messaging/package<dot>lisp file
File, Lisp, chrome-native-messaging/read.lisp: The chrome-native-messaging/read<dot>lisp file
File, Lisp, chrome-native-messaging/send.lisp: The chrome-native-messaging/send<dot>lisp file

L
Lisp File, chrome-native-messaging.asd: The chrome-native-messaging<dot>asd file
Lisp File, chrome-native-messaging/package.lisp: The chrome-native-messaging/package<dot>lisp file
Lisp File, chrome-native-messaging/read.lisp: The chrome-native-messaging/read<dot>lisp file
Lisp File, chrome-native-messaging/send.lisp: The chrome-native-messaging/send<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   I   R   S  
Index Entry  Section

F
Function, integer-to-bytes: Internal functions
Function, read-from-ext: Exported functions
Function, read-length: Internal functions
Function, send-to-ext: Exported functions

I
integer-to-bytes: Internal functions

R
read-from-ext: Exported functions
read-length: Internal functions

S
send-to-ext: Exported functions

Jump to:   F   I   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
chrome-native-messaging: The chrome-native-messaging system
chrome-native-messaging: The chrome-native-messaging package

P
Package, chrome-native-messaging: The chrome-native-messaging package

S
System, chrome-native-messaging: The chrome-native-messaging system

Jump to:   C   P   S