E-MailRelay

gsaslserverfactory.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2024 Graeme Walker <graeme_walker@users.sourceforge.net>
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program. If not, see <http://www.gnu.org/licenses/>.
16// ===
17///
18/// \file gsaslserverfactory.h
19///
20
21#ifndef G_SASL_SERVER_FACTORY_H
22#define G_SASL_SERVER_FACTORY_H
23
24#include "gdef.h"
25#include "gsaslserver.h"
26#include "gsecrets.h"
27#include "goptional.h"
28#include <utility>
29#include <memory>
30
31 namespace GAuth
32{
33 class SaslServerFactory ;
34}
35
36//| \class GAuth::SaslServerFactory
37/// Provides a factory function for SaslServer instances.
38///
39 class GAuth::SaslServerFactory
40{
41 public:
42 static std::unique_ptr<SaslServer> newSaslServer( const SaslServerSecrets & ,
43 bool allow_pop , const std::string & config ,
44 const std::string & challenge_domain ) ;
45 ///< A factory function for a SaslServer.
46
47 public:
48 SaslServerFactory() = delete ;
49} ;
50
51#endif
GAuth::SaslServerFactory
Provides a factory function for SaslServer instances.
Definition: gsaslserverfactory.h:40
GAuth::SaslServerFactory::newSaslServer
static std::unique_ptr< SaslServer > newSaslServer(const SaslServerSecrets &, bool allow_pop, const std::string &config, const std::string &challenge_domain)
A factory function for a SaslServer.
Definition: gsaslserverfactory_basic.cpp:26
GAuth::SaslServerSecrets
An interface used by GAuth::SaslServer to obtain authentication secrets.
Definition: gsaslserversecrets.h:40
goptional.h
gsaslserver.h
gsecrets.h
GAuth
SASL authentication classes.
Definition: gcram.cpp:38