uamqp.authentication.cbs_auth.CBSAuthMixin.yml

### YamlMime:PythonClass
uid: uamqp.authentication.cbs_auth.CBSAuthMixin
name: CBSAuthMixin
fullName: uamqp.authentication.cbs_auth.CBSAuthMixin
module: uamqp.authentication.cbs_auth
inheritances:
- builtins.object
summary: Mixin to handle sending and refreshing CBS auth tokens.
constructor:
  syntax: CBSAuthMixin()
methods:
- uid: uamqp.authentication.cbs_auth.CBSAuthMixin.close_authenticator
  name: close_authenticator
  summary: Close the CBS auth channel and session.
  signature: close_authenticator()
- uid: uamqp.authentication.cbs_auth.CBSAuthMixin.create_authenticator
  name: create_authenticator
  summary: 'Create the AMQP session and the CBS channel with which

    to negotiate the token.'
  signature: create_authenticator(connection, debug=False, **kwargs)
  parameters:
  - name: connection
    description: 'The underlying AMQP connection on which

      to create the session.'
    isRequired: true
    types:
    - <xref:uamqp.connection.Connection>
  - name: debug
    description: 'Whether to emit network trace logging events for the

      CBS session. Default is *False*. Logging events are set at INFO level.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    types:
    - <xref:uamqp.c_uamqp.CBSTokenAuth>
- uid: uamqp.authentication.cbs_auth.CBSAuthMixin.handle_token
  name: handle_token
  summary: 'This function is called periodically to check the status of the current

    token if there is one, and request a new one if needed.

    If the token request fails, it will be retried according to the retry policy.

    A token refresh will be attempted if the token will expire soon.


    This function will return a tuple of two booleans. The first represents whether

    the token authentication has not completed within it''s given timeout window.
    The

    second indicates whether the token negotiation is still in progress.'
  signature: handle_token()
  return:
    types:
    - <xref:tuple>[<xref:bool>, <xref:bool>]
  exceptions:
  - type: uamqp.errors.AuthenticationException if the token authentication fails.
  - type: uamqp.errors.TokenExpired if the token has expired and cannot berefreshed.
- uid: uamqp.authentication.cbs_auth.CBSAuthMixin.update_token
  name: update_token
  summary: 'Update a token that is about to expire. This is specific

    to a particular token type, and therefore must be implemented

    in a child class.'
  signature: update_token()