package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

Platform dedicated to the analysis of source code written in C

Install

Dune Dependency

frama-c.com Readme Edit opam file Versions (25)

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-31.0-Gallium.tar.gz

sha256=a94384f00d53791cbb4b4d83ab41607bc71962d42461f02d71116c4ff6dca567

doc/frama-c-server.core/Server/Main/index.html

Module `Server.Main`Source

Server Main Process

Sourcetype json = Frama_c_kernel.Json.t

Sourcetype kind = [

| `GET
| `SET
| `EXEC

]

Sourceval string_of_kind : kind -> string

Sourceval pp_kind : Stdlib.Format.formatter -> kind -> unit

Request Registry

Sourceval register : kind -> string -> (json -> json) -> unit

Sourceval find : string -> (kind * (json -> json)) option

Sourceval exec : string -> json -> json

raises Not_found
if not registered.

Signals Registry

Sourcetype signal

Sourceval signal : string -> signal

Sourceval signal_name : signal -> string

Server Main Process

Sourcetype 'a request = [

| `Poll
| `Request of 'a * string * json
| `Kill of 'a
| `SigOn of string
| `SigOff of string
| `Shutdown

]

Type of request messages. Parametrized by the type of request identifiers.

Sourcetype 'a response = [

| `Data of 'a * json
| `Error of 'a * string
| `Killed of 'a
| `Rejected of 'a
| `Signal of string
| `CmdLineOn
| `CmdLineOff

]

Type of response messages. Parametrized by the type of request identifiers.

Sourcetype 'a message = {

requests : 'a request list;
callback : 'a response list -> unit;

}

A paired request-response message. The callback will be called exactly once for each received message.

Sourcetype 'a server

Source

val create : 
  pretty:(Stdlib.Format.formatter -> 'a -> unit) ->
  ?equal:('a -> 'a -> bool) ->
  fetch:(unit -> 'a message option) ->
  unit ->
  'a server

Run a server with the provided low-level network primitives to actually exchange data. Logs are monitored unless ~logs:false is specified.

Default equality is the standard `(=)` one.

Sourceval start : 'a server -> unit

Start the server in background.

The function returns immediately after installing a daemon that (only) accepts GET requests received by the server on calls to Async.yield().

Shall be scheduled at command line main stage via Boot.Main.extend extension point.

Sourceval stop : 'a server -> unit

Stop the server if it is running in background.

Can be invoked to force server shutdown at any time.

It shall be typically scheduled via Extlib.safe_at_exit along with other system cleanup operations to make sure the server is property shutdown before Frama-C main process exits.

Sourceval run : 'a server -> unit

Run the server forever. The server would now accept any kind of requests and start handling them. While executing an `EXEC request, the server would continue to handle (only) `GET pending requests on Async.yield() at every server.polling time interval.

The function will not return until the server is actually shutdown.

Shall be scheduled at normal command line termination via Cmdline.at_normal_exit extension point.

Sourceval kill : unit -> 'a

Kill the currently running request by raising an exception.

Sourceval emit : signal -> unit

Emit the server signal to the client.

Sourceval on_signal : signal -> (bool -> unit) -> unit

The callback is invoked with true on SIGON command and false on SIGOFF.

Sourceval on : (bool -> unit) -> unit

Register a callback to listen for server activity. All callbacks are executed in their order of registration. Callbacks shall never raise any exception.

Sourceval once : (unit -> unit) -> unit

Register a callback to listen for server initialization. All callbacks are executed once, in their order of registration, and before activity callbacks. Callbacks shall never raise any exception.

Sourceval async : ('a -> 'b) -> 'a -> 'b Frama_c_kernel.Task.task

Register an asynchronous task on the server. When the server is not working in background, this is equivalent to Task.call ; otherwize, the continuation is scheduled on the server like an `EXEC request.

Sourceval is_active : unit -> bool

Returns true if the server is currently running.

On This Page

Request Registry
Signals Registry
Server Main Process

package frama-c

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frama-c-server.core/Server/Main/index.html

Module Server.MainSource

Request Registry

Signals Registry

Server Main Process

Module `Server.Main`Source