Freeciv-3.2
|
Public Member Functions | |
__init__ (self, ScriptConfig cfg, str packet_type, int packet_number, str flags_text, typing.Iterable[str] lines, typing.Callable[[str], RawFieldType] resolve_type) | |
str | name (self) |
bool | no_packet (self) |
str | extra_send_args (self) |
str | extra_send_args2 (self) |
str | extra_send_args3 (self) |
str | send_prototype (self) |
str | lsend_prototype (self) |
str | dsend_prototype (self) |
str | dlsend_prototype (self) |
"set[str]" | all_caps (self) |
str | get_struct (self) |
str | get_prototypes (self) |
str | get_stats (self) |
str | get_report_part (self) |
str | get_reset_part (self) |
str | get_send (self) |
str | get_variants (self) |
str | get_lsend (self) |
str | get_dsend (self) |
str | get_dlsend (self) |
Static Public Attributes | |
CANCEL_PATTERN = re.compile(r"^cancel\((.*)\)$") | |
str | is_info = "no" |
bool | want_dsend = False |
bool | want_lsend = False |
bool | want_force = False |
bool | want_pre_send = False |
bool | want_post_send = False |
bool | want_post_recv = False |
bool | delta = True |
bool | no_handle = False |
bool | handle_via_packet = True |
bool | handle_per_conn = False |
Represents a single packet type (possibly with multiple variants)
Definition at line 2419 of file generate_packets.py.
generate_packets.Packet.__init__ | ( | self, | |
ScriptConfig | cfg, | ||
str | packet_type, | ||
int | packet_number, | ||
str | flags_text, | ||
typing.Iterable[str] | lines, | ||
typing.Callable[[str], RawFieldType] | resolve_type | ||
) |
Reimplemented in generate_packets.PacketsDefinition.
Definition at line 2468 of file generate_packets.py.
"set[str]" generate_packets.Packet.all_caps | ( | self | ) |
Set of all capabilities affecting this packet
Reimplemented in generate_packets.PacketsDefinition.
Definition at line 2637 of file generate_packets.py.
str generate_packets.Packet.dlsend_prototype | ( | self | ) |
Prototype for the dlsend function (directly takes values; list of connections)
Definition at line 2630 of file generate_packets.py.
str generate_packets.Packet.dsend_prototype | ( | self | ) |
Prototype for the dsend function (directly takes values instead of a packet struct)
Definition at line 2624 of file generate_packets.py.
str generate_packets.Packet.extra_send_args | ( | self | ) |
Argements for the regular send function
Definition at line 2583 of file generate_packets.py.
str generate_packets.Packet.extra_send_args2 | ( | self | ) |
Arguments passed from lsend to send See also extra_send_args
Definition at line 2592 of file generate_packets.py.
str generate_packets.Packet.extra_send_args3 | ( | self | ) |
Arguments for the dsend and dlsend functions
Definition at line 2604 of file generate_packets.py.
str generate_packets.Packet.get_dlsend | ( | self | ) |
Generate the implementation of the dlsend function, combining dsend and lsend functionality. See self.get_dsend() and self.get_lsend()
Definition at line 2782 of file generate_packets.py.
str generate_packets.Packet.get_dsend | ( | self | ) |
Generate the implementation of the dsend function, which directly takes packet fields instead of a packet struct.
Definition at line 2762 of file generate_packets.py.
str generate_packets.Packet.get_lsend | ( | self | ) |
Generate the implementation of the lsend function, which takes a list of connections to send a packet to.
Definition at line 2748 of file generate_packets.py.
str generate_packets.Packet.get_prototypes | ( | self | ) |
Generate the header prototype declarations for the public functions associated with this packet.
Definition at line 2660 of file generate_packets.py.
str generate_packets.Packet.get_report_part | ( | self | ) |
Generate this packet's part of the delta_stats_report() function. See Variant.get_report_part() and PacketsDefinition.code_delta_stats_report
Definition at line 2686 of file generate_packets.py.
str generate_packets.Packet.get_reset_part | ( | self | ) |
Generate this packet's part of the delta_stats_reset() function. See Variant.get_reset_part() and PacketsDefinition.code_delta_stats_reset
Definition at line 2693 of file generate_packets.py.
str generate_packets.Packet.get_send | ( | self | ) |
Generate the implementation of the send function, which sends a given packet to a given connection.
Definition at line 2700 of file generate_packets.py.
str generate_packets.Packet.get_stats | ( | self | ) |
Generate the code declaring counters for this packet's variants. See Variant.get_stats()
Definition at line 2680 of file generate_packets.py.
str generate_packets.Packet.get_struct | ( | self | ) |
Generate the struct definition for this packet
Definition at line 2642 of file generate_packets.py.
str generate_packets.Packet.get_variants | ( | self | ) |
Generate all code associated with individual variants of this packet; see the Variant class (and its methods) for details.
Definition at line 2728 of file generate_packets.py.
str generate_packets.Packet.lsend_prototype | ( | self | ) |
Prototype for the lsend function (takes a list of connections)
Definition at line 2618 of file generate_packets.py.
str generate_packets.Packet.name | ( | self | ) |
Snake-case name of this packet type
Definition at line 2572 of file generate_packets.py.
bool generate_packets.Packet.no_packet | ( | self | ) |
Whether this packet's send functions should take no packet argument. This is the case iff this packet has no fields.
Definition at line 2577 of file generate_packets.py.
str generate_packets.Packet.send_prototype | ( | self | ) |
Prototype for the regular send function
Definition at line 2613 of file generate_packets.py.
generate_packets.Packet.cancel |
Definition at line 2482 of file generate_packets.py.
|
static |
Definition at line 2422 of file generate_packets.py.
generate_packets.Packet.cfg |
Definition at line 2470 of file generate_packets.py.
Definition at line 2454 of file generate_packets.py.
generate_packets.Packet.delta |
Definition at line 2520 of file generate_packets.py.
generate_packets.Packet.dirs |
Definition at line 2541 of file generate_packets.py.
generate_packets.Packet.fields |
Definition at line 2544 of file generate_packets.py.
Definition at line 2464 of file generate_packets.py.
generate_packets.Packet.handle_per_conn |
Definition at line 2529 of file generate_packets.py.
Definition at line 2460 of file generate_packets.py.
generate_packets.Packet.handle_via_packet |
Definition at line 2526 of file generate_packets.py.
|
static |
Definition at line 2428 of file generate_packets.py.
generate_packets.Packet.is_info |
Definition at line 2496 of file generate_packets.py.
generate_packets.Packet.key_fields |
Definition at line 2550 of file generate_packets.py.
generate_packets.Packet.name |
Definition at line 2537 of file generate_packets.py.
Definition at line 2457 of file generate_packets.py.
generate_packets.Packet.no_handle |
Definition at line 2523 of file generate_packets.py.
generate_packets.Packet.other_fields |
Definition at line 2552 of file generate_packets.py.
generate_packets.Packet.type |
Definition at line 2472 of file generate_packets.py.
generate_packets.Packet.type_number |
Definition at line 2477 of file generate_packets.py.
generate_packets.Packet.variants |
Definition at line 2565 of file generate_packets.py.
Definition at line 2432 of file generate_packets.py.
generate_packets.Packet.want_dsend |
Definition at line 2502 of file generate_packets.py.
Definition at line 2440 of file generate_packets.py.
generate_packets.Packet.want_force |
Definition at line 2508 of file generate_packets.py.
Definition at line 2436 of file generate_packets.py.
generate_packets.Packet.want_lsend |
Definition at line 2505 of file generate_packets.py.
Definition at line 2450 of file generate_packets.py.
generate_packets.Packet.want_post_recv |
Definition at line 2517 of file generate_packets.py.
Definition at line 2447 of file generate_packets.py.
generate_packets.Packet.want_post_send |
Definition at line 2514 of file generate_packets.py.
Definition at line 2444 of file generate_packets.py.
generate_packets.Packet.want_pre_send |
Definition at line 2511 of file generate_packets.py.