mike-jumper commented on a change in pull request #267: GUACAMOLE-513: Implement Wake-on-LAN support in libguac URL: https://github.com/apache/guacamole-server/pull/267#discussion_r407910688
########## File path: src/libguac/guacamole/wol-constants.h ########## @@ -0,0 +1,43 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 + * + * http://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. + */ + +#ifndef __GUAC_WOL_CONSTANTS_H +#define __GUAC_WOL_CONSTANTS_H + +/** + * Header file that provides constants and defaults related to libguac + * Wake-on-LAN support. + * + * @file wol-constants.h + */ + +/** + * The default broadcast address to which Wake-on-LAN packets will be sent + * if one is not specified. + */ +#define GUAC_WOL_DEFAULT_BROADCAST "255.255.255.255" Review comment: The reason I have issue with "default" here is that we're essentially _recommending_ that behavior be implemented as a default, not actually implementing a default. It feels like libguac should not concern itself with what protocol implementations may choose to be their defaults. If some aspect of this WoL implementation implemented its own defaults in the case that specific values are omitted (if `NULL` is passed for the address, a negative value for the timeout, etc.), then I completely agree with documenting these as defaults within libguac since that's exactly what they would be - libguac's defaults. Outside of that, I think the aspect of these values being defaults (or not) would be a private concern of the implementation using libguac. If the main goal with these defaults is to avoid duplicated code within the bundled protocol support, perhaps some sort of private `defaults.h` within `src/common/` would be better? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
