stop-consumer


   

SYNOPSIS


    Stops a RabbitMQ consumer.
   

SYNTAX


    stop-consumer [-name] <String> [<CommonParameters>]
   
   

DESCRIPTION


    The stop-consumer cmdlet stops all message processing and releases
    all resources used by the RabbitMQ client.
   
    Once a consumer is passed to the stop-consumer cmdlet, it should be
    considered disposed and should be used with any other PoshRabbit cmdlet.

PARAMETERS


    -name <String>
        The name of the consumer to stop.
       
        Required?                    true
        Position?                    1
        Default value               
        Accept pipeline input?       true (ByPropertyName)
        Accept wildcard characters? 
       
    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer and OutVariable. For more information, type,
        "get-help about_commonparameters".
   

INPUTS


    The consumer instance to stop.
   
   

OUTPUTS


    RabbitMQ.Client.Events.BasicDeliverEventArgs[]. Any messages dequeued by
    the consumer since the last call to receive-consumer or wait-consumer.
   
   

NOTES


   
   
        Messages and BasicAck
        ---------------------
        Messages are available during the current PowerShell session and are discarded
        one the session ends.  Because the queues created by start-consumer use auto-
        acknowledge, messages are considered acknowledged once the consumer dequeues
        them.  Any message dequeued by the consumer will not be requeued in
        the RabbitMQ server.
   
    -------------------------- EXAMPLE 1 --------------------------
   
    C:\PS>$q = start-consumer -hostname RbtSvr -exchange ps -routingkey 't.?'
   
   
    # ...
    C:\PS> $q | stop-consumer;
   
   
    Description
    -----------
    This example shows how to stop a consumer.
   
   
   
   
   
   

RELATED LINKS


    start-consumer

Last edited Nov 22, 2010 at 3:14 AM by beefarino, version 2

Comments

No comments yet.