| SUMMARY: CONSTR | METHOD | DETAIL: CONSTR | METHOD | 
Note that significant functionality is written in XS/C in order to minimize tracing/debugging overhead.
Permission is granted to use this software under the same terms as Perl itself. Refer to the Perl Artistic License for details.
Unless otherwise noted, $self
 is the object instance variable.
| Constructor Summary | 
|---|
| monitor($file)Opens an existing mmap'd file for read-only access (for simple monitor applications) | 
| new(File => value, GlobalSize => value, MessageSize => value, Rings => value, Slots => value, SlotSize => value, StopOnCreate => value, TraceOnCreate => value)Using a combination of the optional C<%args> and various environment variables, creates and initializes a mmap'ed file in read/write mode with the ring buffer structures | 
| open($file)Opens an existing mmap'd file for read/write access (for interactive debuggers) | 
| Method Summary | 
|---|
| allocate()Allocate a ring buffer | 
| close()Deprecated. 1 | 
| free($ring)Free a ring | 
| getAddress()Get base address of the mmap'ed file | 
| getCount()Get the number of configured rings | 
| getGlobalMsg()Gets a message from the global message area | 
| getHeader()Get the RingBuffer global header fields | 
| getMap()Get the free buffer map | 
| getMmap()Get the IPC::Mmap object used to store the ringbuffer | 
| getName()Get the name of the mmap'ed file | 
| getRing($ringnum)Open and return a Devel::RingBuffer::Ring object for the specified ring number | 
| getSingle()Gets the value of the global single field | 
| getSlotSize()Get the configured size of slots | 
| getSlots()Get the configured number of slots per ring | 
| getStopOnCreate()Get the value of the stop_on_create field | 
| getTraceOnCreate()Get the value of the trace_on_create field | 
| reallocate()Re-allocates a ring buffer | 
| setGlobalMsg($msg)Sets a message into the global message area | 
| setSingle(value => value)Sets the value of the global single field | 
| setStopOnCreate()Sets the value of the stop_on_create field | 
| setTraceOnCreate($trace_on_create)Sets the value of the trace_on_create field | 
| Constructor Details | 
|---|
open($file)
$file - optional name of mmap'ed file (or namespace for Win32)
new(File => value, GlobalSize => value, MessageSize => value, Rings => value, Slots => value, SlotSize => value, StopOnCreate => value, TraceOnCreate => value)
File => name of the file to be created for memory mapping.
GlobalSize => size of global monitor <=> AUT message buffer.
MessageSize => size of per-thread monitor <=> AUT message buffer.
Rings => Number of rings to create in the ring buffer.
Slots => Number of slots per ring.
SlotSize => Slot size in bytes.
StopOnCreate => Initial value for stop_on_create flag.
TraceOnCreate => Initial value for trace_on_create flag.
monitor($file)
$file - optional name of mmap'ed file (or namespace for Win32)
| Method Details | 
|---|
allocate()
close()
free($ring)
$ring - the ring object to be freed
getAddress()
getCount()
getGlobalMsg()
getHeader()
getMap()
getMmap()
getName()
getRing($ringnum)
$ringnum - number of ring to be opened
getSingle()
getSlotSize()
getSlots()
getStopOnCreate()
getTraceOnCreate()
reallocate()
setGlobalMsg($msg)
$msg - the message to send
setSingle(value => value)
value => to set
setStopOnCreate()
setTraceOnCreate($trace_on_create)
$trace_on_create - value to set