source: BMXNET_RPMS_dotNET_UTILITIES-BMX/branch/IHS BMX Framework/IndianHealthService.BMXNet.Doc/Help/html/58d4523c-9538-8ef8-a06c-5ae73a5250ff.htm@ 1146

Last change on this file since 1146 was 1146, checked in by Sam Habiel, 14 years ago

Initial Import of BMX4
File size: 17.1 KB
Line 
1<html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:msxsl="urn:schemas-microsoft-com:xslt"><head><META NAME="save" CONTENT="history" /><title>IndianHealthService.BMXNet Namespace</title><link rel="stylesheet" type="text/css" href="../styles/presentation.css" /><link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /><link rel="stylesheet" type="text/css" href="ms-help://Dx/DxRuntime/DxLink.css" /><script type="text/javascript" src="../scripts/EventUtilities.js"> </script><script type="text/javascript" src="../scripts/SplitScreen.js"> </script><script type="text/javascript" src="../scripts/Dropdown.js"> </script><script type="text/javascript" src="../scripts/script_manifold.js"> </script><script type="text/javascript" src="../scripts/LanguageFilter.js"> </script><script type="text/javascript" src="../scripts/DataStore.js"> </script><script type="text/javascript" src="../scripts/CommonUtilities.js"> </script><script type="text/javascript" src="../scripts/MemberFilter.js"> </script><meta name="guid" content="58d4523c-9538-8ef8-a06c-5ae73a5250ff" /></head><body><input type="hidden" id="userDataCache" class="userDataStyle" /><input type="hidden" id="hiddenScrollOffset" /><img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" title="Collapse image" /><img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" title="Expand Image" /><img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collall.gif" title="CollapseAll image" /><img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expall.gif" title="ExpandAll image" /><img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected.gif" title="DropDown image" /><img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected_hover.gif" title="DropDownHover image" /><img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" title="Copy image" /><img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" title="CopyHover image" /><img id="checkBoxSelectImage" style="display:none; height:0; width:0;" src="../icons/ch_selected.gif" /><img id="checkBoxUnSelectImage" style="display:none; height:0; width:0;" src="../icons/ch_unselected.gif" /><img id="checkBoxSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/ch_selected_hover.gif" /><img id="checkBoxUnSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/ch_unselected_hover.gif" /><img id="radioSelectImage" style="display:none; height:0; width:0;" src="../icons/r_select.gif" /><img id="radioUnSelectImage" style="display:none; height:0; width:0;" src="../icons/r_unselect.gif" /><img id="radioSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/r_select_hover.gif" /><img id="radioUnSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/r_unselect_hover.gif" /><img id="curvedLeftSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_lft_cnr.gif" /><img id="curvedRightSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_rt_cnr.gif" /><img id="curvedLeftUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_lft_cnr.gif" /><img id="curvedRightUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_rt_cnr.gif" /><img id="gradLeftSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_lft_grad.gif" /><img id="gradRightSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_sel_rt_grad.gif" /><img id="gradLeftUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_lft_grad.gif" /><img id="gradRightUnSelectImage" style="display:none; height:0; width:0;" src="../icons/tab_unsel_rt_grad.gif" /><img id="twirlSelectImage" style="display:none; height:0; width:0;" src="../icons/twirl_selected.gif" /><img id="twirlUnSelectImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected.gif" /><img id="twirlSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/twirl_selected_hover.gif" /><img id="twirlUnSelectHoverImage" style="display:none; height:0; width:0;" src="../icons/twirl_unselected_hover.gif" /><img id="NSRBottomImage" style="display:none; height:0; width:0;" src="../icons/NSRbottomgrad.gif" /><div id="header"><table id="topTable"><tr id="headerTableRow3"><td><span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"><img ID="toggleAllImage" class="toggleAll" src="../icons/collall.gif" title="CollapseAll image" /><label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span> | <span id="languageFilterToolTip" style="cursor:default;" onmouseover="languageFilterImage.src=dropDownHoverImage.src;" onmouseout="languageFilterImage.src=dropDownImage.src;" tabindex="0"><img id="languageFilterImage" src="../icons/twirl_unselected.gif" title="DropDown image" /><label id="VisualBasicLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual Basic</label><label id="CSharpLabel" for="languageFilterImage" style="display: none;">Language Filter: C#</label><label id="ManagedCPlusPlusLabel" for="languageFilterImage" style="display: none;">Language Filter: Visual C++</label><label id="JavaScriptLabel" for="languageFilterImage" style="display: none;">Language Filter: JavaScript</label></span><div id="languageSpan"><div id="VisualBasic" onclick="changeLanguage(data, 'VisualBasic', 'vb');"><img id="VisualBasicImage" onmouseover="mouseOverCheck(VisualBasicImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(VisualBasicImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> Visual Basic</div><br /><div id="CSharp" onclick="changeLanguage(data, 'CSharp', 'cs');"><img id="CSharpImage" onmouseover="mouseOverCheck(CSharpImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(CSharpImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> C#</div><br /><div id="ManagedCPlusPlus" onclick="changeLanguage(data, 'ManagedCPlusPlus', 'cpp');"><img id="ManagedCPlusPlusImage" onmouseover="mouseOverCheck(ManagedCPlusPlusImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(ManagedCPlusPlusImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> Visual C++</div><br /><div id="JavaScript" onclick="changeLanguage(data, 'JavaScript', 'cs');"><img id="JavaScriptImage" onmouseover="mouseOverCheck(JavaScriptImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" onmouseout="mouseOutCheck(JavaScriptImage,radioSelectImage,radioUnSelectImage,radioSelectHoverImage,radioUnSelectHoverImage)" src="../icons/r_unselect.gif" /> JavaScript</div><br /></div></td></tr><tr id="headerTableRow1"><td align="left"><span id="runningHeaderText">.NET Framework Class Library</span></td></tr><tr id="headerTableRow2"><td align="left"><span id="nsrTitle">IndianHealthService.BMXNet Namespace</span></td></tr><tr><td class="nsrBottom" background="../icons/NSRbottomgrad.gif" /></tr></table></div><div id="mainSection"><div id="mainBody"><div id="allHistory" class="saveHistory" onsave="saveAll()" onload="loadAll()" /><div class="header"><font color="darkgray" /><p><font color="#a9a9a9">BMXNET 4.0 Developer API</font></p></div><h1 class="heading"><span onclick="ExpandCollapse(typesToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(typesToggle, event)" tabindex="0"><img id="typesToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Types</span></h1><div id="typesSection" class="section" name="collapseableSection" style=""><div id="typeSection"><table class="filter" cellspacing="0" cellpadding="0"><tr id="curvedTypeTabs"><td class="leftTab" value="all"> </td><td class="middleTab" value="all"> </td><td class="rightTab" value="all"> </td><td class="leftTab" value="class"> </td><td class="middleTab" value="class"> </td><td class="rightTab" value="class"> </td><td class="leftTab" value="interface"> </td><td class="middleTab" value="interface"> </td><td class="rightTab" value="interface"> </td></tr><tr class="tabs" id="typeFilter"><td class="leftGrad" value="all"> </td><td class="tab" value="all" onclick="toggleClass('typeFilter','value','all','activeTab','tab'); curvedToggleClass('curvedTypeTabs','value','all');processSubgroup('all', 'type'); process('typeList','filterElement','type');">All Types</td><td class="rightGrad" value="all"> </td><td class="leftGrad" value="class"> </td><td class="tab" value="class" onclick="toggleClass('typeFilter','value','class','activeTab','tab'); curvedToggleClass('curvedTypeTabs','value','class'); processSubgroup('class', 'type'); process('typeList','filterElement','type');">Classes <img src="../icons/pubclass.gif" title="Public class" /></td><td class="rightGrad" value="class"> </td><td class="leftGrad" value="interface"> </td><td class="tab" value="interface" onclick="toggleClass('typeFilter','value','interface','activeTab','tab'); curvedToggleClass('curvedTypeTabs','value','interface'); processSubgroup('interface','type'); process('typeList','filterElement','type');">Interfaces<img src="../icons/pubinterface.gif" title="Public interface" /></td><td class="rightGrad" value="interface"> </td></tr></table><div class="memberSection"><table id="typeList" class="members" cellspacing="0"><tr><th class="iconColumn"> </th><th class="nameColumn">Name</th><th class="descriptionColumn">Description</th></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" title="Public class" /></td><td><a href="6709c3fc-8485-5de4-5943-5cdbcdddaef2.htm">BMXNetException</a></td><td><div class="summary">
2 This simple exception wrapper is used for Exceptions thrown by umknown sources and
3 by the BMX library. Check the InnerException for details.
4 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="910c3f49-0ac2-a4b3-8f40-322056f67d0f.htm">LocalConsumer</a></td><td><div class="summary">
5 This interface is used on UserControl-based components which are designed to work both inside
6 the EHR and inside a WinForm application. "Consumer" interfaces basically tell Frameworks
7 that a "Consumer"-implementating object need a specific service, versus the service being queried.
8 </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" title="Public class" /></td><td><a href="89efa519-c5ff-d211-f211-68bc28c83821.htm">LocalEventArgs</a></td><td><div class="summary">
9 The event args used by the LocalEventService.
10 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="15caa148-27cf-145d-5c41-d9abaae3aa48.htm">LocalEventService</a></td><td><div class="summary">
11 Access to local services are access through this interface.
12 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="7ecd8110-4e57-3113-15d9-6a1a24fafd6c.htm">LocalSession</a></td><td><div class="summary">
13 The LocalSession is scoped to the client, whether EHR/VueCentric or a WinForm application.
14 User management, patient/visit context, and local events are the key services. Components/controls that are programmed
15 against this API will work within both the EhrFramework and WinFramework environments.
16 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="4c17571a-e494-5713-db3f-dd7b96515d2f.htm">Log</a></td><td><div class="summary">
17 Current Logging facility for BMXNet. This facility conforms to the EHR/VueCentric
18 method of logging. Logging is either on or off, there is no scale from Info to Fatal to
19 turn off and on.
20 </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" title="Public class" /></td><td><a href="a09a9c3a-dee2-8109-dfd6-024c51b0f7f1.htm">M</a></td><td><div class="summary">
21 Common M[umps] related function libraries implemented with static members.
22 </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" title="Public class" /></td><td><a href="cbe9cc61-7f07-59d3-a564-08d7dd762bbf.htm">RemoteEventArgs</a></td><td><div class="summary">
23 The event args used by the RemoteEventService
24 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="35115a38-b0d9-27b3-344f-980aaedcdc61.htm">RemoteEventService</a></td><td><div class="summary">
25 All async communications with RPMS is performed through the RemoteEventService which
26 is found by calling aRemoteSession.EventServices.
27 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="15218990-392b-2525-75b3-834166ec97f7.htm">RemoteSession</a></td><td><div class="summary">
28 All server-side RPMS RPC calls are performed through this interface. Each instance of RemoteSession corresponds to a single job (e.g. Cache process) on RPMS. There is always one primary RemoteSession and potentially more when using RemoteSessionPool. When the primary RemoteSession is closed all secondary pooled sessions are also closed and the server broker connection is terminated.
29 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="fc2f4074-14a7-1587-7183-b1a7f25f8089.htm">RemoteSessionConsumer</a></td><td><div class="summary">
30 This interface is used on an UserControl-based components that are designed to work both inside
31 the EHR and inside a WinForm application. The "Consumer" interfaces basically tell Frameworks
32 that "Consumer" implementating objects need an specific service.
33 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="b3f76bb0-260c-817a-c4b1-f785742c370c.htm">RemoteSessionPool</a></td><td><div class="summary">
34 <p>
35 Each BMX connection to RPMS contains a single RemoteSessionPool with at least
36 one Session, the primary session. Applications that need additional server processes
37 beyond what can be done with async commands can used the RemoteSessionPool.
38 </p>
39 <p>
40 Access to the RemoteSessionPool is accomplished by implementing the RemoteSessionPoolConsumer
41 interface on your component/control. Secondary sessions can be opened and closed as they
42 are needed. If the AvailableSessionCount is zero then a null RemoteSession is returned so it
43 is recommend to first check the if a pool HasAvailableSessions before an OpenSession() request.
44 </p>
45 <p>
46 RemoteSessionPool high-performance can be achieved by keeping RPMS server jobs alive even after
47 secondary sessions are closed. The pool will maintain MaxSessions - 1 number of jobs alive on the
48 server. If the application is finished for awhile needing IdleSessionCount idle jobs, then
49 TerminateIdleSessions() will release those resources on the server. New jobs will then be created
50 on demand.
51 </p>
52
53 </div></td></tr><tr data="interface; public"><td><img src="../icons/pubinterface.gif" title="Public interface" /></td><td><a href="f7acf09e-f89c-7419-22ea-db1b05210616.htm">RemoteSessionPoolConsumer</a></td><td><div class="summary">
54 This interface is used on an UserControl-based components that are designed to work both inside
55 the EHR and inside a WinForm application. The "Consumer" interfaces basically tell Frameworks
56 that "Consumer" implementating objects need an specific service.
57 </div></td></tr></table></div></div></div><div id="footer"><div class="footerLine"><img width="100%" height="3px" src="../icons/footer.gif" title="Footer image" /></div>
58 <p />
59 <span>
60 Send
61 <a href="javascript:sendfeedback('Documentation Feedback (Sandcastle CTP): ', 'IndianHealthService.BMXNet Namespace', '');">
62
63 comments
64 </a>
65 about this topic to Microsoft.
66 </span>
67 </div></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.