# laravel-queue-cmq

**Repository Path**: lain99/laravel-queue-cmq

## Basic Information

- **Project Name**: laravel-queue-cmq
- **Description**:  Tencent Cloud Message Queue driver for Laravel Queue
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://cloud.tencent.com/product/cmq
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2018-06-18
- **Last Updated**: 2020-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CMQ Queue driver for Laravel

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
[![Packagist Version](https://img.shields.io/packagist/v/freyo/laravel-queue-cmq.svg?style=flat-square)](https://packagist.org/packages/freyo/laravel-queue-cmq)
[![Total Downloads](https://img.shields.io/packagist/dt/freyo/laravel-queue-cmq.svg?style=flat-square)](https://packagist.org/packages/freyo/laravel-queue-cmq)

![image](https://mc.qcloudimg.com/static/img/7fc29d4e11d2ae302cf7f77d16c78f42/CMQ.svg)

Tencent Cloud Message Queue driver for Laravel Queue

腾讯云 CMQ 消息队列

## Installation

  ```shell
  composer require freyo/laravel-queue-cmq
  ```

## Configure

**Laravel 5.5+ uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.**

1. `config/app.php`:

  ```php
  'providers' => [
    // ...
    Freyo\LaravelQueueCMQ\LaravelQueueCMQServiceProvider::class,
  ]
  ```
  
2. `.env`:

  ```
  QUEUE_DRIVER=cmq
  
  CMQ_SECRET_KEY=
  CMQ_SECRET_ID=
  
  CMQ_QUEUE_HOST=https://cmq-queue-region.api.qcloud.com
  CMQ_QUEUE=queue_name
  CMQ_QUEUE_POLLING_WAIT_SECONDS=30
  
  CMQ_TOPIC_ENABLE=false # set to true to use topic
  CMQ_TOPIC_FILTER=routing # or msgtag
  CMQ_TOPIC_HOST=https://cmq-topic-region.api.qcloud.com
  CMQ_TOPIC=topic_name
  ```
  
#### Tips
  
- Region should be replaced with a specific region: gz (Guangzhou), sh (Shanghai), or bj (Beijing).
  
- Domain for public network API request: cmq-queue-region.api.qcloud.com / cmq-topic-region.api.qcloud.com
  
- Domain for private network API request: cmq-queue-region.api.tencentyun.com / cmq-topic-region.api.tencentyun.com
  
## Usage

Once you completed the configuration you can use Laravel Queue API. If you used other queue drivers you do not need to change anything else. If you do not know how to use Queue API, please refer to the official Laravel documentation: http://laravel.com/docs/queues

#### Example

  ```php
  //use queue only
  Job::dispatch()->onQueue('queue-name');
  
  //use topic and tag filter
  Job::dispatch()->onQueue('tag1,tag2,tag3');
  
  //use topic and routing filter
  Job::dispatch()->onQueue('routing-key');
  ```

## Document

- [Overview](https://cloud.tencent.com/document/product/406?lang=en)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.