/// <reference path="../../dts/_import/index.d.ts" />
/// <reference path="../interface/Socket.d.ts" />
/// <reference path="../interface/Stream.d.ts" />
/// <reference path="../interface/Smtp.d.ts" />
/// <reference path="../interface/TcpServer.d.ts" />
/// <reference path="../interface/UrlObject.d.ts" />
/**
 * @description 网络访问模块
 * 
 *  基础模块。可用于创建和操作网络资源，引用方式：
 *  ```JavaScript
 *  var net = require('net');
 *  ```
 *  
 */
declare module 'net' {
    /**
     * @description 地址集常量，指定 unix socket 
     */
    export const AF_UNIX: 1;

    /**
     * @description 地址集常量，指定 Windows pipe 
     */
    export const AF_PIPE: 1;

    /**
     * @description 地址集常量，指定 ipv4
     */
    export const AF_INET: 2;

    /**
     * @description 地址集常量，指定 ipv6
     */
    export const AF_INET6: 10;

    /**
     * @description 查询和设置 socket 后端是否使用 uv，缺省为 false 
     */
    var use_uv_socket: boolean;

    /**
     * @description 查询当前运行环境网络信息
     *      @return 返回网卡信息
     *     
     */
    function info(): FIBJS.GeneralObject;

    /**
     * @description 查询给定的主机名的地址
     *      @param name 指定主机名
     *      @param family 指定查询返回类型，缺省为 AF_INET
     *      @return 返回查询的 ip 字符串
     *      
     */
    function resolve(name: string, family: number): string;

    function resolve(name: string, family: number, callback: (err: Error | undefined | null, retVal: string)=>any): void;

    /**
     * @description 快速查询的主机地址，等效与 resolve(name)
     *      @param name 指定主机名
     *      @return 返回查询的 ip 字符串
     *      
     */
    function ip(name: string): string;

    function ip(name: string, callback: (err: Error | undefined | null, retVal: string)=>any): void;

    /**
     * @description 快速查询的主机 ipv6 地址，等效与 resolve(name, net.AF_INET6)
     *      @param name 指定主机名
     *      @return 返回查询的 ipv6 字符串
     *      
     */
    function ipv6(name: string): string;

    function ipv6(name: string, callback: (err: Error | undefined | null, retVal: string)=>any): void;

    /**
     * @description 创建一个 Socket 对象，参见 Socket 
     */
    const Socket: typeof Class_Socket;

    /**
     * @description 创建一个 Socket 或 SslSocket 对象并建立连接
     *      @param url 指定连接的协议，可以是：tcp://host:port 或者 ssl://host:port，也可以是：unix:/usr/local/proc1 或者 pipe://./pipe/proc1，连接 pipe 时需要用 `/` 替换 `\`
     *      @param timeout 指定超时时间，单位是毫秒，默认为0
     *      @return 返回连接成功的 Socket 或者 SslSocket 对象
     *      
     */
    function connect(url: string, timeout?: number): Class_Stream;

    function connect(url: string, timeout?: number, callback?: (err: Error | undefined | null, retVal: Class_Stream)=>any): void;

    /**
     * @description 创建一个 Smtp 对象，参见 Smtp 
     */
    const Smtp: typeof Class_Smtp;

    /**
     * @description 创建一个 Smtp 对象并建立连接，参见 Smtp
     *      @param url 指定连接的协议，可以是：tcp://host:port 或者 ssl://host:port
     *      @param timeout 指定超时时间，单位是毫秒，默认为0
     *      @return 返回连接成功的 Smtp 对象
     *      
     */
    function openSmtp(url: string, timeout?: number): Class_Smtp;

    function openSmtp(url: string, timeout?: number, callback?: (err: Error | undefined | null, retVal: Class_Smtp)=>any): void;

    /**
     * @description 创建一个 TcpServer 对象，参见 TcpServer 
     */
    const TcpServer: typeof Class_TcpServer;

    /**
     * @description 创建一个 UrlObject 对象，参见 UrlObject 
     */
    const Url: typeof Class_UrlObject;

    /**
     * @description 查询当前系统异步网络引擎
     *      @return 返回网络引擎名称
     *     
     */
    function backend(): string;

    /**
     * @description 检测输入是否是 IP 地址
     *      @param ip 指定要检测的字符串
     *      @return 非合法的 IP 地址，返回 0, 如果是 IPv4 则返回 4，如果是 IPv6 则返回 6
     *     
     */
    function isIP(ip?: string): number;

    /**
     * @description 检测输入是否是 IPv4 地址
     *      @param ip 指定要检测的字符串
     *      @return 如果是 IPv4 则返回 true.否则返回 false
     *     
     */
    function isIPv4(ip?: string): boolean;

    /**
     * @description 检测输入是否是 IPv6 地址
     *      @param ip 指定要检测的字符串
     *      @return 如果是 IPv6 则返回 true.否则返回 false
     *     
     */
    function isIPv6(ip?: string): boolean;

}