blob: 8d952f740b8001eeb895cefb86b4b341f31f9090 [file] [log] [blame]
MG Mud User88f12472016-06-24 23:31:02 +02001SYNOPSIS
Zesstra715ec202025-07-09 22:18:31 +02002 int binary_message(int *|bytes message, int flags)
MG Mud User88f12472016-06-24 23:31:02 +02003
Zesstra715ec202025-07-09 22:18:31 +02004DESCRIPTION
5 Flush output and send output directly with write WITHOUT IAC QUOTING.
6 The message may contain zeroes if given as int *.
7 The messages goes to this_object(), but only if interactive.
8 return value: number of characters actually written.
9 Any 'allowed charset' setting is ignored.
MG Mud User88f12472016-06-24 23:31:02 +020010
Zesstra715ec202025-07-09 22:18:31 +020011 Flag settings are interpreted bitwise and may be ored
12 together (only for clients not using MCCP compression):
MG Mud User88f12472016-06-24 23:31:02 +020013
Zesstra715ec202025-07-09 22:18:31 +020014 Bit 0 (value 1): when set, add_message() is used instead of
15 write(). Thus no previous flushing of the buffer is
16 needed, but the output is not immediate, nor can the
17 number of bytes actually sent be determined - the return
18 value is undefined.
19 Bit 1 (value 2): The buffer is flushed _after_ adding the
20 message. Useful only in conjunction with Bit 0.
MG Mud User88f12472016-06-24 23:31:02 +020021
Zesstra715ec202025-07-09 22:18:31 +020022 The idea behind the flag settings is that sending command
23 codes for colours and other things needs to bypass the allowed
24 charset filters, but isn't important enough to waste bandwith
25 on a synchronous transmission.
MG Mud User88f12472016-06-24 23:31:02 +020026
Zesstra715ec202025-07-09 22:18:31 +020027HISTORY
28 Introduced in 3.2.1@40.
29 Argument 'flags' introduced in 3.2.1@60.
MG Mud User88f12472016-06-24 23:31:02 +020030
Zesstra715ec202025-07-09 22:18:31 +020031SEE ALSO
MG Mud User88f12472016-06-24 23:31:02 +020032 set_connection_charset(E)