package shared-memory-ring

You can search for identifiers within the package.

in-package search v0.2.0

shared-memory-ring
- CHANGES
- LICENSE
- README
- Library shared-memory-ring
  - Console_ring
    
    Ring
    
    Front
    
    Reader
    
    Writer
    
    Back
    
    Reader
    
    Writer
  - Ring
    
    Rpc
    
    Front
    
    Back
    
    RW
    
    Reverse
    
    STREAM
    
    READABLE
    
    WRITABLE
    
    S
    
    Reader
    
    Writer
    
    Pipe
    
    Reader
    
    Writer
    
    Bidirectional_byte_stream
    
    Front
    
    Reader
    
    Writer
    
    Back
    
    Reader
    
    Writer
  - Xenstore_ring
    
    Ring
    
    Front
    
    Reader
    
    Writer
    
    Back
    
    Reader
    
    Writer
- Sources
  - shared-memory-ring
    
    console_ring.ml
    
    ring.ml
    
    xenstore_ring.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module type `Ring.READABLE`Source

A stream of readable items

include STREAM

Sourcetype stream = Cstruct.t

Sourcetype position = int32

A stream remains at a fixed position so that repeated calls to read or write process the same data. To advance the stream call advance new_position

Sourceval advance : stream -> position -> unit

advanced stream position declares that we have processed all data up to position and therefore any buffers may be recycled.

Sourceval read : stream -> position * Cstruct.t

read stream returns the data at the current stream position. Note this function does not advance the stream, so repeated calls should return the same data. To advance the stream, call advance position.

package shared-memory-ring

Module type Ring.READABLESource

Module type `Ring.READABLE`Source