📄 vxwsm.html
字号:
<html><head><!-- /vobs/wpwr/docs/vxworks/ref/VXWSm.html - generated by refgen from /vobs/wpwr/docs/vxworks/ref/VXWSm.i --> <title> VXWSm </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>VxWorks Reference Manual : Wind Foundation Classes</i></a></p></blockquote><h1>VXWSm</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>VXWSm</strong> - support for shared memory objects</p></blockquote><h4>METHODS</h4><blockquote><p><p><b><i><a href="./VXWSm.html#VXWSmBSem::VXWSmBSem">VXWSmBSem::VXWSmBSem</a></i>( )</b> - create and initialize binary shared-memory semaphore (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmBSem::VXWSmBSem_1">VXWSmBSem::VXWSmBSem</a></i>( )</b> - build a binary shared-memory semaphore object (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmCSem::VXWSmCSem">VXWSmCSem::VXWSmCSem</a></i>( )</b> - create and initialize a shared memory counting semaphore (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmCSem::VXWSmCSem_1">VXWSmCSem::VXWSmCSem</a></i>( )</b> - build a shared-memory counting semaphore object (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmMsgQ::VXWSmMsgQ">VXWSmMsgQ::VXWSmMsgQ</a></i>( )</b> - create and initialize a shared-memory message queue (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmMemPart::VXWSmMemPart">VXWSmMemPart::VXWSmMemPart</a></i>( )</b> - create a shared memory partition (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmMemBlock::VXWSmMemBlock">VXWSmMemBlock::VXWSmMemBlock</a></i>( )</b> - allocate a block of memory from the shared memory system partition (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmMemBlock::VXWSmMemBlock_1">VXWSmMemBlock::VXWSmMemBlock</a></i>( )</b> - allocate memory for an array from the shared memory system partition (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmMemBlock::~VXWSmMemBlock">VXWSmMemBlock::~VXWSmMemBlock</a></i>( )</b> - free a shared memory system partition block of memory (VxMP Option)<br><b><i><a href="./VXWSm.html#VXWSmMemBlock::baseAddress">VXWSmMemBlock::baseAddress</a></i>( )</b> - address of shared-memory block<br><p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This library defines wrapper classes for VxWorks shared-memoryobjects: <b>VXWSmBSem</b> (shared-memory binary semaphores), <b>VXWSmCSem</b>(shared-memory counting semaphores), <b>VXWSmMsgQ</b> (shared-memorymessage queues), <b>VXWSmMemPart</b> (shared memory partitions), and<b>VXWSmMemBlock</b> (shared memory blocks).<p></blockquote><h4>INHERITANCE</h4><blockquote><p>All of the shared-memory object wrappers inherit the public membersof <b>VXWSmNameLib</b>.<p>The <b>VXWSmBSem</b> and <b>VXWSmCSem</b> classes also inherit from <b><a href="./VXWSem.html#top">VXWSem</a></b>;<b>VXWSmMsgQ</b> also inherits from <b><a href="./VXWMsgQ.html#top">VXWMsgQ</a></b>; <b>VXWSmMemPart</b> alsoinherits from <b>VXWMemPArt</b>.<p></blockquote><h4>INCLUDE FILES</h4><blockquote><p><b>vxwSmLib.h</b><p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./VXWSm.html#top">VXWSm</a></b>, <b>vxwSmNameLib</b>, <b>vxwMsgQLib</b>, <b>vxwMemPartLib</b>, <b>vxwSemLib</b>, <i>VxWorks Programmer's Guide: Shared-Memory Objects</i><p><p><hr><a name="VXWSmBSem::VXWSmBSem"></a><p align=right><a href="rtnIndex.html"><i>Wind Foundation Classes : Methods</i></a></p></blockquote><h1><i>VXWSmBSem::VXWSmBSem</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>VXWSmBSem::VXWSmBSem</i>( )</strong> - create and initialize binary shared-memory semaphore (VxMP Option)</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>VXWSmBSem ( int opts, SEM_B_STATE istate, char * name = 0 )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine allocates and initializes a shared memory binary semaphore.The semaphore is initialized to an initial state <i>istate</i> of either<b>SEM_FULL</b> (available) or <b>SEM_EMPTY</b> (not available). The shared semaphorestructure is allocated from the shared semaphore dedicated memorypartition. Use the optional <i>name</i> argument to identify the newsemaphore by name.<p>The queuing style for blocked tasks is set by <i>opts</i>; the onlysupported queuing style for shared memory semaphores is first-in-first-out,selected by <b>SEM_Q_FIFO</b>.<p>The maximum number of shared memory semaphores (binary plus counting) thatcan be created is <b>SM_OBJ_MAX_SEM</b>, defined in <b>configAll.h</b>.<p></blockquote><h4>AVAILABILITY</h4><blockquote><p>This routine depends on code distributed as a component of the unbundledshared memory support option, VxMP.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A.<p></blockquote><h4>ERRNO</h4><blockquote><p><p> S_smMemLib_NOT_ENOUGH_MEMORY<br> S_semLib_INVALID_QUEUE_TYPE<br> S_semLib_INVALID_STATE<br> S_smObjLib_LOCK_TIMEOUT<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./VXWSm.html#top">VXWSm</a></b>, <b>vxwSemLib</b>, <b>vxwSmNameLib</b><hr><a name="VXWSmBSem::VXWSmBSem_1"></a><p align=right><a href="rtnIndex.html"><i>Wind Foundation Classes : Methods</i></a></p></blockquote><h1><i>VXWSmBSem::VXWSmBSem</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>VXWSmBSem::VXWSmBSem</i>( )</strong> - build a binary shared-memory semaphore object (VxMP Option)</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>VXWSmBSem ( char * name, int waitType )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine builds a shared-memory binary semaphore object aroundan existing named shared-memory semaphore. The <i>name</i> argumentidentifies the existing semaphore; <i>waitType</i> specifies whether towait if the desired name is not found in the shared-memory namedatabase; see <b><i><a href="./VXWSmName.html#VXWSmName::nameGet">VXWSmName::nameGet</a></i>( )</b>.<p>Use this routine to take advantage of the VXWSmBSem class whileworking with semaphores created by some other means (for example,previously existing C code).<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A.<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><i><a href="./VXWSmName.html#VXWSmName::nameGet">VXWSmName::nameGet</a></i>( )</b><hr><a name="VXWSmCSem::VXWSmCSem"></a><p align=right><a href="rtnIndex.html"><i>Wind Foundation Classes : Methods</i></a></p></blockquote><h1><i>VXWSmCSem::VXWSmCSem</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>VXWSmCSem::VXWSmCSem</i>( )</strong> - create and initialize a shared memory counting semaphore (VxMP Option)</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>VXWSmCSem ( int opts, int icount, char * name = 0 )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine allocates and initializes a shared memory countingsemaphore. The initial count value of the semaphore (the number oftimes the semaphore must be taken before it can be given) is specifiedby <i>icount</i>.<p>The queuing style for blocked tasks is set by <i>opts</i>; the onlysupported queuing style for shared memory semaphores is first-in-first-out,selected by <b>SEM_Q_FIFO</b>.<p>The maximum number of shared memory semaphores (binary plus counting) thatcan be created is <b>SM_OBJ_MAX_SEM</b>, defined in <b>configAll.h</b>.<p></blockquote><h4>AVAILABILITY</h4><blockquote><p>This routine depends on code distributed as a component of the unbundledshared memory support option, VxMP.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A.<p></blockquote><h4>ERRNO</h4><blockquote><p><p> S_smMemLib_NOT_ENOUGH_MEMORY<br> S_semLib_INVALID_QUEUE_TYPE<br> S_smObjLib_LOCK_TIMEOUT<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./VXWSm.html#top">VXWSm</a></b>, <b>vxwSemLib</b>, <b>vxwSmNameLib</b><hr><a name="VXWSmCSem::VXWSmCSem_1"></a><p align=right><a href="rtnIndex.html"><i>Wind Foundation Classes : Methods</i></a></p></blockquote><h1><i>VXWSmCSem::VXWSmCSem</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>VXWSmCSem::VXWSmCSem</i>( )</strong> - build a shared-memory counting semaphore object (VxMP Option)</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>VXWSmCSem ( char * name, int waitType )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine builds a shared-memory semaphore object aroundan existing named shared-memory counting semaphore. The <i>name</i> argumentidentifies the existing semaphore, and <i>waitType</i> specifies whether towait if the desired name is not found in the shared-memory namedatabase; see <b><i><a href="./VXWSmName.html#VXWSmName::nameGet">VXWSmName::nameGet</a></i>( )</b>.<p>Use this routine to take advantage of the VXWSmBSem class whileworking with semaphores created by some other means (for example,previously existing C code).<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A.<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><i><a href="./VXWSmName.html#VXWSmName::nameGet">VXWSmName::nameGet</a></i>( )</b><hr><a name="VXWSmMsgQ::VXWSmMsgQ"></a><p align=right><a href="rtnIndex.html"><i>Wind Foundation Classes : Methods</i></a></p></blockquote><h1><i>VXWSmMsgQ::VXWSmMsgQ</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>VXWSmMsgQ::VXWSmMsgQ</i>( )</strong> - create and initialize a shared-memory message queue (VxMP Option)</p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -