/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
* Jonathan Schleifer <js@webkeks.org>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFException.h"
#ifndef OF_HAVE_SOCKETS
# error No sockets available!
#endif
/*!
* @class OFConnectionFailedException \
* OFConnectionFailedException.h ObjFW/OFConnectionFailedException.h
*
* @brief An exception indicating that a connection could not be established.
*/
@interface OFConnectionFailedException: OFException
{
id _socket;
OFString *_host;
uint16_t _port;
int _errNo;
}
#ifdef OF_HAVE_PROPERTIES
@property (readonly, retain) id socket;
@property (readonly, copy) OFString *host;
@property (readonly) uint16_t port;
@property (readonly) int errNo;
#endif
/*!
* @brief Creates a new, autoreleased connection failed exception.
*
* @param host The host to which the connection failed
* @param port The port on the host to which the connection failed
* @param socket The socket which could not connect
* @return A new, autoreleased connection failed exception
*/
+ (instancetype)exceptionWithHost: (OFString*)host
port: (uint16_t)port
socket: (id)socket;
/*!
* @brief Creates a new, autoreleased connection failed exception.
*
* @param host The host to which the connection failed
* @param port The port on the host to which the connection failed
* @param socket The socket which could not connect
* @param errNo The errno of the error that occurred
* @return A new, autoreleased connection failed exception
*/
+ (instancetype)exceptionWithHost: (OFString*)host
port: (uint16_t)port
socket: (id)socket
errNo: (int)errNo;
/*!
* @brief Initializes an already allocated connection failed exception.
*
* @param host The host to which the connection failed
* @param port The port on the host to which the connection failed
* @param socket The socket which could not connect
* @return An initialized connection failed exception
*/
- initWithHost: (OFString*)host
port: (uint16_t)port
socket: (id)socket;
/*!
* @brief Initializes an already allocated connection failed exception.
*
* @param host The host to which the connection failed
* @param port The port on the host to which the connection failed
* @param socket The socket which could not connect
* @param errNo The errno of the error that occurred
* @return An initialized connection failed exception
*/
- initWithHost: (OFString*)host
port: (uint16_t)port
socket: (id)socket
errNo: (int)errNo;
/*!
* @brief Returns the socket which could not connect.
*
* @return The socket which could not connect
*/
- (id)socket;
/*!
* @brief Returns the host to which the connection failed.
*
* @return The host to which the connection failed
*/
- (OFString*)host;
/*!
* @brief Returns the port on the host to which the connection failed.
*
* @return The port on the host to which the connection failed
*/
- (uint16_t)port;
/*!
* @brief Returns the errno of the error that occurred.
*
* @return The errno of the error that occurred
*/
- (int)errNo;
@end