/** * Copyright 2023 Angus.Fenying * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * https://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /// import * as $Net from 'node:net'; import * as D from './../Decl'; export interface ITcpClientOptions extends D.IConnectOptions { /** * The hostname the server is listening on. * * @type string * @default 'localhost' */ hostname?: string; /** * The port number the server is listening on. * * > Set to 0 to have the operating system assign a random port. * * @type uint16 * @default 8698 */ port?: number; /** * The existing socket to use. * * > If the socket is specified, `hostname` and `port` are ignored. * * > Only available at the first time connecting. * * @default null */ socket?: $Net.Socket | D.ISocketFactory | null; /** * The timeout for connecting to the server, in milliseconds. * * @default 30000 */ connectTimeout?: number; } /** * Connect to a LwDFX server through TCP protocol. * * @param opts Connection options. * @param callback Callback function. */ export declare function connect(opts: ITcpClientOptions): Promise; //# sourceMappingURL=TcpClient.d.ts.map