ircg_pconnect

(PHP 4 >= 4.0.4, PHP 5 <= 5.0.4)

ircg_pconnect -- Connect to an IRC server

Description

resource ircg_pconnect ( string username [, string server_ip [, int server_port [, string msg_format [, array ctcp_messages [, array user_settings [, bool bailout_on_trivial]]]]]] )

ircg_pconnect() will try to establish a connection to an IRC server.

Parameters

username

The initial nickname on the server.

server_ip

The IRC server address.

server_ip must be an IP address in numerical form. DNS lookups are expensive and should be done in the context of IRCG. Default to 127.0.0.1.

server_port

The server port number. Default to 6667.

msg_format

You can customize the output of IRC messages and events by selecting a format message set previously created with ircg_register_format_messages() by specifying the set's name in msg_format.

ctcp_messages

If you want to handle CTCP messages such as ACTION (/me), you need to define a mapping from CTCP type (e.g. ACTION) to a custom format string. Do this by passing an associative array as ctcp_messages. The keys of the array are the CTCP type and the respective value is the format message.

user_settings

You can define "ident", "password", and "realname" tokens which are sent to the IRC server by setting these in this associative array.

bailout_on_trivial

Return Values

Returns a connection resource handle for further use, or FALSE on error.

See Also

ircg_disconnect()
ircg_is_conn_alive()
ircg_register_format_messages()