LocalAddress.h

Go to the documentation of this file.

/*
 
Copyright (c) 2013, Komodo Does Inc
All rights reserved.
 
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Komodo Does Inc nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
*/
 
#ifndef LOCAL_ADDRESS_H
#define LOCAL_ADDRESS_H
 
#ifndef ADDRESS_H
#include "Address.h"
#endif // ADDRESS_H
 
namespace BsdSockets {
 
  /*
   * Forward Declarations
   */
  class LowLevelAddress;
  class LocalAddressPimpl;
 
  /** \class LocalAddress
   *
   * \brief Local Socket Address (formerly Unix Domain Socket) Address representing
   * a named pipe's name.
   */
  class LocalAddress : public Address {
  public:
    typedef std::shared_ptr<LocalAddress> Ptr;
 
    /** Virtual destructor to support derived classes */
    virtual ~LocalAddress();
 
    /** Create from thePath string
     *
     * @param thePath path to create from, cannot be empty, must be shorter 
     * than the unspecified maximum length for this system.
     *
     * @return LocalAddress created
     */
    static LocalAddress::Ptr create(const std::string& thePath);
 
  private:
    /** Create from thePath string
     *
     * @param thePath path to create from, cannot be empty, must be shorter 
     * than the unspecified maximum length for this system.
     * @param a blank address is allowed only from accept()
     */
    LocalAddress(const std::string& thePath, bool allowBlank = false);
 
  private:
    LocalAddress() = delete;
    LocalAddress(const LocalAddress& rhs) = delete;
    LocalAddress(LocalAddress&& rhs) = delete;
    LocalAddress& operator=(const LocalAddress& rhs) = delete;
    LocalAddress& operator=(LocalAddress&& rhs) = delete;
 
  public:
    /** @return the path of this LocalAddress */
    const std::string& getPath() const;
 
  public:
    virtual std::shared_ptr<LowLevelAddress> makeTempLowLevelAddress() const;
    virtual Address::Ptr create(std::shared_ptr<LowLevelAddress> lowLevelAddress) const;
    virtual LowLevelAddress& getLowLevelAddress() const;
 
  private:
    /** The path of this LocalAddress */
    const std::string path;
 
    /** The private implementation of this LocalAddress */
    std::shared_ptr<LocalAddressPimpl> pimpl;
  };
 
} // namespace BsdSockets
 
#endif // LOCAL_ADDRESS_H