Class: MintPress::OracleTrafficDirector::TcpListener

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties, OtdCommon
Defined in:
src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb

Overview

set the TCP listener properties.

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

28
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 28

property :name, type: String
  • #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration] (Default Value: Proc.new { tcp_proxy_name.configuration })
    'Name of the configuration.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    • default ⇒ Proc.new { tcp_proxy_name.configuration }
    

31
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 31

property :configuration, description: 'Name of the configuration.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String, delete_prop: true, otd_delete_mandatory: true, set_prop: true, default: Proc.new { tcp_proxy_name.configuration }
  • #tcp_listener ⇒ String (Default Value: Proc.new { self.name })
    'Name of the TCP listener.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • default ⇒ Proc.new { self.name }
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

33
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 33

property :tcp_listener, description: 'Name of the TCP listener.', otd_prop: true, otd_mandatory: true, type: String, default: Proc.new { self.name }, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #port ⇒ Integer
    'Port on which to listen. Range of values: port number between 1 and 65535, inclusive.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • set_prop ⇒ true
    

36
37
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 36

property :port, description: 'Port on which to listen.
Range of values: port number between 1 and 65535, inclusive.', otd_prop: true, otd_mandatory: true, type: Integer, set_prop: true
  • #tcp_proxy ⇒ [MintPress::OracleTrafficDirector::TcpProxy]
    'Name that identifies the exposed TCP service. Name can consist of one or more characters, whitespace is not permitted.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • set_prop ⇒ true
    

39
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 39

property :tcp_proxy, description: 'Name that identifies the exposed TCP service. Name can consist of one or more characters, whitespace is not permitted.', set_prop: true, type: [MintPress::OracleTrafficDirector::TcpProxy], from: String
  • #enabled ⇒ [TrueClass, FalseClass]
    'Whether the instance is enabled. Range of values: true or false. Default: true.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

43
44
45
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 43

property :enabled, description: 'Whether the instance is enabled.
Range of values: true or false.
Default: true.', otd_prop: true, type: [TrueClass, FalseClass], set_prop: true
  • #ip ⇒ String
    'IP address on which to listen. Range of values: *, a hostname, or an IP address. Default: *.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

49
50
51
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 49

property :ip, description: 'IP address on which to listen.
Range of values: *, a hostname, or an IP address.
Default: *.', otd_prop: true, type: String, set_prop: true
  • #acceptor_threads ⇒ String
    'Acceptor threads for this listening end point. Range of values: 1 - 128. Default: auto-tuned.'
    Property Attributes
    • otd_prop ⇒ true
    • from ⇒ Integer
    • set_prop ⇒ true
    

55
56
57
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 55

property :acceptor_threads, description: 'Acceptor threads for this listening end point.
Range of values: 1 - 128.
Default: auto-tuned.', otd_prop: true, from: Integer, type: String, set_prop: true
  • #blocking_accept ⇒ [TrueClass, FalseClass]
    'Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when MaxProcs > 1). Range of values: true or false. Default: false.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

61
62
63
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 61

property :blocking_accept, description: 'Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when MaxProcs > 1).
Range of values: true or false.
Default: false.', otd_prop: true, type: [TrueClass, FalseClass], set_prop: true
  • #description ⇒ String
    'Description of the TCP listener for the administrators reference.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

65
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 65

property :description, description: 'Description of the TCP listener for the administrators reference.', otd_prop: true, type: String, set_prop: true
  • #family ⇒ String
    'Protocol family. Range of values: default, inet, inet6, or inet-sdp. Default: auto-tuned.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

69
70
71
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 69

property :family, description: 'Protocol family.
Range of values: default, inet, inet6, or inet-sdp.
Default: auto-tuned.', otd_prop: true, type: String, set_prop: true
  • #listen_queue_size ⇒ Integer
    'Maximum size of the operating system listen queue backlog. Range of values: 1 - 1048576. Default: 128.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

75
76
77
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 75

property :listen_queue_size, description: 'Maximum size of the operating system listen queue backlog.
Range of values: 1 - 1048576.
Default: 128.', otd_prop: true, type: Integer, set_prop: true
  • #receive_buffer_size ⇒ Integer
    'Size (in bytes) of the operating system socket receive buffer. Range of values: size in bytes between 0 and 2147483647, inclusive.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

80
81
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 80

property :receive_buffer_size, description: 'Size (in bytes) of the operating system socket receive buffer.
Range of values: size in bytes between 0 and 2147483647, inclusive.', otd_prop: true, type: Integer, set_prop: true
  • #send_buffer_size ⇒ Integer
    'Size (in bytes) of the operating system socket send buffer. Range of values: size in bytes between 0 and 2147483647, inclusive.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

84
85
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 84

property :send_buffer_size, description: 'Size (in bytes) of the operating system socket send buffer.
Range of values: size in bytes between 0 and 2147483647, inclusive.', otd_prop: true, type: Integer, set_prop: true
  • #ssl ⇒ MintPress::OracleTrafficDirector::TcpListenerSsl (Default Value: MintPress::OracleTrafficDirector::TcpListenerSsl.new)
    'TcpListenerSsl static object'
    Property Attributes
    • default ⇒ MintPress::OracleTrafficDirector::TcpListenerSsl.new
    

89
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 89

property :ssl, type: MintPress::OracleTrafficDirector::TcpListenerSsl, default: MintPress::OracleTrafficDirector::TcpListenerSsl.new, description: 'TcpListenerSsl static object'
  • #parent ⇒ MintPress::OracleTrafficDirector::TcpProxy

    Property Attributes 
    

90
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener.rb', line 90

property :parent, type: MintPress::OracleTrafficDirector::TcpProxy

Properties (Read Only)

Constant Summary collapse

MODEL_PARENTS = 
["configuration", "tcp-proxy-name"]
LIST_PARAMS = 
["configuration"]
GET_PARAMS = 
["configuration", "tcp-listener"]

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary collapse

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Attributes included from OtdCommon

#harvested

Instance Method Summary collapse

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from OtdCommon

#can_exist?, #creator_available?, #delete_generic, #delete_props, #destroy_generic, #disable_props, #empty_mbean?, #enable_prop_generic, #enable_props, #exist_generic?, #form_props, #get_domain, #get_property_from_target, #get_props, #handle_type, #harvest, #harvesters, #harvesting, #list_generic, #list_props, #otd_create_generic, #otd_propize, #set_prop_generic, #set_props

Constructor Details

#initialize(opts = {}) ⇒ TcpListener

Returns a new instance of TcpListener.

Instance Attribute Details

#get_params ⇒ Object

Returns the value of attribute get_params.

#list_params ⇒ Object

Returns the value of attribute list_params.

#model_parents ⇒ Object

Returns the value of attribute model_parents.

Instance Method Details

#create ⇒ Object

#destroy ⇒ Object

#exist? ⇒ Boolean

Returns:

  • (Boolean)