docs/MQTransProducer.html

<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title>MQ Nodejs HTTP SDK Documents Class: MQTransProducer</title>

	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">

	<link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">

</head>

<body>

<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
	<div class="navbar-header">
		<a class="navbar-brand" href="index.html">MQ Nodejs HTTP SDK Documents</a>
		<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
			<span class="icon-bar"></span>
        </button>
	</div>
	<div class="navbar-collapse collapse" id="topNavigation">
		<ul class="nav navbar-nav">
			
			<li class="dropdown">
				<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
				<ul class="dropdown-menu ">
					<li><a href="MessageProperties.html">MessageProperties</a></li><li><a href="MQClient.html">MQClient</a></li><li><a href="MQConsumer.html">MQConsumer</a></li><li><a href="MQProducer.html">MQProducer</a></li><li><a href="MQTransProducer.html">MQTransProducer</a></li>
				</ul>
			</li>
			
		</ul>
        
            <div class="col-sm-3 col-md-3">
                <form class="navbar-form" role="search">
                    <div class="input-group">
                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
                        <div class="input-group-btn">
                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
                        </div>
                    </div>
                </form>
            </div>
        
	</div>

</div>
</div>


<div class="container" id="toc-content">
<div class="row">

	
	<div class="col-md-8">
	
		<div id="main">
			

	<h1 class="page-title">Class: MQTransProducer</h1>
<section>

<header>
    
        <h2>
        MQTransProducer
        </h2>
        
            <div class="class-description"><p>MQ的消息生产者，支持事务</p></div>
        
    
</header>


<article>
    <div class="container-overview">
    
        
<hr>
<dt>
    <h4 class="name" id="MQTransProducer"><span class="type-signature"></span>new MQTransProducer(client, instanceId, topic, groupId)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>构造函数</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>client</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="MQClient.html">MQClient</a></span>


            </td>

            
            <td class="description last"><p>MQ的客户端</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>instanceId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>实例ID</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>topic</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>主题名字</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>groupId</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>客户端GroupID</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="client.js.html">client.js</a>,
				 <a href="client.js.html#sunlight-1-line-444">line 444</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Returns:</h5>
    
            
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="MQTransProducer.html">MQTransProducer</a></span>


    </dd>
</dl>


</dd>

    
    </div>

    
        <h3 class="subsection-title">Methods</h3>

        <dl>
            
<hr>
<dt>
    <h4 class="name" id="commit"><span class="type-signature">&lt;async> </span>commit(receiptHandle)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>提交事务消息</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>receiptHandle</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>consumeHalfMessage返回的单条消息句柄或者是发送事务消息返回的句柄</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="client.js.html">client.js</a>,
				 <a href="client.js.html#sunlight-1-line-612">line 612</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Throws:</h5>
    
            
<dl>
    <dt>
        <div class="param-desc">
        <p>err 请求失败或者其它网络异常</p>
<pre class="prettyprint source lang-json"><code>{
 // MQ服务端返回的错误Code，如ReceiptHandleError，表示消息句柄非法，MessageNotExist如果超过了TransCheckImmunityTime（针对发送事务消息的句柄）或者超过NextCnosumeTime
 Code: &quot;&quot;
 // 请求ID
 RequestId: &quot;&quot;
}
</code></pre>
        </div>
    </dt>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">exception</span>


            </dd>
        </dl>
    </dt>
</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <pre class="prettyprint source lang-json"><code>{
 // 请求成功
 code:204,
 // 请求ID
 requestId:&quot;&quot;
}
</code></pre>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="consumeHalfMessage"><span class="type-signature">&lt;async> </span>consumeHalfMessage(numOfMessages, waitSeconds)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>消费检查事务半消息,默认如果该条消息没有被 {commit} 或者 {rollback} 在NextConsumeTime时会再次消费到该条消息</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>numOfMessages</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
            <td class="description last"><p>每次从服务端消费条消息</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>waitSeconds</code></td>
            

            <td class="type">
            
                
<span class="param-type">int</span>


            </td>

            
            <td class="description last"><p>长轮询的等待时间（可空），如果服务端没有消息请求会在该时间之后返回等于请求阻塞在服务端，如果期间有消息立刻返回</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="client.js.html">client.js</a>,
				 <a href="client.js.html#sunlight-1-line-572">line 572</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Throws:</h5>
    
            
<dl>
    <dt>
        <div class="param-desc">
        <p>err  MQ服务端返回的错误或者其它网络异常</p>
<pre class="prettyprint source lang-json"><code> {
   // MQ服务端返回的错误Code，其中MessageNotExist是正常现象，表示没有可消费的消息
   Code: &quot;&quot;,
   // 请求ID
   RequestId: &quot;&quot;
 }
```json</code></pre>
        </div>
    </dt>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">exception</span>


            </dd>
        </dl>
    </dt>
</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <pre class="prettyprint source lang-json"><code>{
 code: 200,
 requestId: &quot;&quot;,
 body: [
   {
     // 消息ID
     MessageId: &quot;&quot;,
     // 消息体MD5
     MessageBodyMD5: &quot;&quot;,
     // 发送消息的时间戳，毫秒
     PublishTime: {long},
     // 下次重试消费的时间，前提是这次不调用{commit} 或者 {rollback}，毫秒
     NextConsumeTime: {long},
     // 第一次消费的时间，毫秒，对于顺序消费无意义
     FirstConsumeTime: {long},
     // 消费的次数
     ConsumedTimes: {long},
     // 消息句柄，调用 {commit} 或者 {rollback} 需要将消息句柄传入，用于提交或者回滚该条事务消息
     ReceiptHandle: &quot;&quot;,
     // 消息内容
     MessageBody: &quot;&quot;,
     // 消息标签
     MessageTag: &quot;&quot;
   }
 ]
}

</code></pre>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="publishMessage"><span class="type-signature">&lt;async> </span>publishMessage(body, tag, msgProps)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>向主题发送一条消息</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>body</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>发送的内容</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tag</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>发送消息的标签</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>msgProps</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="MessageProperties.html">MessageProperties</a></span>


            </td>

            
            <td class="description last"><p>发送消息的属性</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="client.js.html">client.js</a>,
				 <a href="client.js.html#sunlight-1-line-507">line 507</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Throws:</h5>
    
            
<dl>
    <dt>
        <div class="param-desc">
        <p>err  MQ服务端返回的错误或者其它网络异常</p>
<pre class="prettyprint source lang-json"><code>{
 // MQ服务端返回的错误Code，like: TopicNotExist 
 Code:&quot;&quot;,
 // 请求ID
 RequestId:&quot;&quot;
}
</code></pre>
        </div>
    </dt>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">exception</span>


            </dd>
        </dl>
    </dt>
</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <pre class="prettyprint source lang-json"><code>{
 // http请求状态码，发送成功就是201，如果发送失败则抛异常
 code: 201,
 // 请求ID
 requestId: &quot;xxxxxxxxxxxxxx&quot;,
 // 发送消息的响应内容
 body: {
   // 消息ID
   MessageId: &quot;&quot;,
   // 消息体内容的MD5值
   MessageBodyMD5: &quot;&quot;
   // 消息句柄，仅事务消息存在
   ReceiptHandle: &quot;&quot;
 }
}
</code></pre>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>


</dd>

        
<hr>
<dt>
    <h4 class="name" id="rollback"><span class="type-signature">&lt;async> </span>rollback(receiptHandle)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>回滚事务消息</p>
    </div>
    

        <h5>Parameters:</h5>
        

<table class="params table table-striped">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>receiptHandle</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>consumeHalfMessage返回的单条消息句柄或者是发送事务消息返回的句柄</p></td>
        </tr>

    
    </tbody>
</table>

    
<dl class="details">
    

	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
	<dd class="tag-source">
		<ul class="dummy">
			<li>
				<a href="client.js.html">client.js</a>,
				 <a href="client.js.html#sunlight-1-line-649">line 649</a>
			</li>
		</ul>
	</dd>
	

</dl>


    <h5>Throws:</h5>
    
            
<dl>
    <dt>
        <div class="param-desc">
        <p>err 请求失败或者其它网络异常</p>
<pre class="prettyprint source lang-json"><code>{
 // MQ服务端返回的错误Code，如ReceiptHandleError，表示消息句柄非法，MessageNotExist如果超过了TransCheckImmunityTime（针对发送事务消息的句柄）或者超过NextCnosumeTime
 Code: &quot;&quot;
 // 请求ID
 RequestId: &quot;&quot;
}
</code></pre>
        </div>
    </dt>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">exception</span>


            </dd>
        </dl>
    </dt>
</dl>


    <h5>Returns:</h5>
    
            
<div class="param-desc">
    <pre class="prettyprint source lang-json"><code>{
 // 请求成功
 code:204,
 // 请求ID
 requestId:&quot;&quot;
}
</code></pre>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">object</span>


    </dd>
</dl>


</dd>

        </dl>
    

</article>

</section>


		</div>
	</div>

	<div class="clearfix"></div>

	
		<div class="col-md-3">
			<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
		</div>
	

</div>
</div>


    <div class="modal fade" id="searchResults">
      <div class="modal-dialog">
        <div class="modal-content">
          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
            <h4 class="modal-title">Search results</h4>
          </div>
          <div class="modal-body"></div>
          <div class="modal-footer">
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div>


<footer>


	<span class="copyright">
	MIT
	</span>

<span class="jsdoc-message">
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
	
		on Wed Nov 17th 2021
	
	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>

<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>

    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>


<script>
$( function () {
	$( "[id*='$']" ).each( function () {
		var $this = $( this );

		$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
	} );

	$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
		var $this = $( this );

		var example = $this.find( "code" );
		exampleText = example.html();
		var lang = /{@lang (.*?)}/.exec( exampleText );
		if ( lang && lang[1] ) {
			exampleText = exampleText.replace( lang[0], "" );
			example.html( exampleText );
			lang = lang[1];
		} else {
			var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
			lang = langClassMatch ? langClassMatch[1] : "javascript";
		}

		if ( lang ) {

			$this
			.addClass( "sunlight-highlight-" + lang )
			.addClass( "linenums" )
			.html( example.html() );

		}
	} );

	Sunlight.highlightAll( {
		lineNumbers : true,
		showMenu : true,
		enableDoclinks : true
	} );

	$.catchAnchorLinks( {
        navbarOffset: 10
	} );
	$( "#toc" ).toc( {
		anchorName  : function ( i, heading, prefix ) {
			return $( heading ).attr( "id" ) || ( prefix + i );
		},
		selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
		showAndHide : false,
		smoothScrolling: true
	} );

	$( "#main span[id^='toc']" ).addClass( "toc-shim" );
	$( '.dropdown-toggle' ).dropdown();

    $( "table" ).each( function () {
      var $this = $( this );
      $this.addClass('table');
    } );

} );
</script>


<!--Navigation and Symbol Display-->


<!--Google Analytics-->


    <script type="text/javascript">
        $(document).ready(function() {
            SearcherDisplay.init();
        });
    </script>


</body>
</html>