DragonFly On-Line Manual Pages

Search: Section:  

sc::ShmMessageGrp(3)                 MPQC                 sc::ShmMessageGrp(3)


NAME

       sc::ShmMessageGrp - The ShmMessageGrp class is an implementation of
       MessageGrp that allows multiple process to be started that communicate
       with shared memory.


SYNOPSIS

       #include <messshm.h>

       Inherits sc::intMessageGrp.

   Public Member Functions
       ShmMessageGrp ()
           Reads the number of processors from environmental variable NUMPROC.
       ShmMessageGrp (const Ref< KeyVal > &)
           The ShmMessageGrp KeyVal constructor takes a single keyword that
           specifies the number of processors.
       ShmMessageGrp (int nprocs)
           Initialize ShmMessageGrp to use nprocs processors.
       void sync ()
           Synchronize all of the processors.
       Ref< MessageGrp > clone (void)
           Returns a copy of this MessageGrp specialization that provides an
           independent communication context.

   Protected Member Functions
       void basic_send (int target, int type, const void *data, int nbyte)
           Must be implemented by specializations.
       void basic_recv (int type, void *data, int nbyte)
           Must be implemented by specializations.
       int basic_probe (int type)
           Must be implemented by specializations.
       void initialize (int nprocs)
       void initialize ()
       msgbuf_t * NEXT_MESSAGE (msgbuf_t *m)
       void get_change (int node)
       void put_change (int node)
       void wait_for_write (int node)
       void release_write (int node)
       void print_buffer (int node, int me)

   Protected Attributes
       commbuf_t * commbuf [MAXPROCS]
       int shmid
       int semid
       int change_semid
       void * sharedmem
       struct sembuf semdec
       struct sembuf seminc

   Additional Inherited Members

Detailed Description
       The ShmMessageGrp class is an implementation of MessageGrp that allows
       multiple process to be started that communicate with shared memory.

       This only provides improved performance if you have multiple CPU's in a
       symmetric multiprocessor configuration. Nonetheless, it is quite useful
       on a single CPU for tracking down bugs.

Constructor & Destructor Documentation
   sc::ShmMessageGrp::ShmMessageGrp (const Ref< KeyVal > &)
       The ShmMessageGrp KeyVal constructor takes a single keyword that
       specifies the number of processors. Here is an example of a
       ParsedKeyVal input that creates a ShmMessageGrp that runs on four
       processors:

       message<ShmMessageGrp>: n = 4

Member Function Documentation
   Ref<MessageGrp> sc::ShmMessageGrp::clone (void) [virtual]
       Returns a copy of this MessageGrp specialization that provides an
       independent communication context.

       Implements sc::MessageGrp.

Author
       Generated automatically by Doxygen for MPQC from the source code.

Version 2.3.1                   Fri Feb 19 2016           sc::ShmMessageGrp(3)

Search: Section: